diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 729ba38e5..2a2437bab 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -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." @@ -2157,6 +2153,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", @@ -7279,6 +7475,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", @@ -7639,6 +8035,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": { @@ -7885,10 +8310,7 @@ }, "examples": { "update-budget": { - "value": { - "message": "Budget successfully updated.", - "id": "550e8400-e29b-41d4-a716-446655440000" - } + "$ref": "#/components/examples/update-budget" } } } @@ -24427,50 +24849,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": { @@ -24481,6 +25035,9 @@ }, "401": { "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -24491,62 +25048,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": { @@ -24555,14 +25077,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" } } } @@ -24587,119 +25106,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": [ { @@ -24709,11 +25130,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": { @@ -24730,6 +25157,15 @@ } ] } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/per-page" } ], "responses": { @@ -24738,7 +25174,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": { @@ -26651,6 +27270,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -29639,252 +30261,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", - "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" - ] - } - }, - "nullable": true - }, - "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", @@ -30225,555 +30601,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", - "example": "Remaining tasks", - "type": "string" - } - }, - "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.", - "example": "last", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$" - } - }, - "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", - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "example": "write", - "type": "string" - } - }, - "nullable": true - }, - "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", @@ -31438,6 +31265,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", @@ -61772,6 +61811,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -61898,7 +61940,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" @@ -61933,6 +61975,9 @@ }, "resolution_comment": { "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + }, + "assignee": { + "$ref": "#/components/schemas/secret-scanning-alert-assignee" } }, "anyOf": [ @@ -61940,6 +61985,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -61949,6 +61999,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -61977,7 +62039,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" @@ -66886,254 +66948,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)", @@ -75394,120 +75208,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": { @@ -75518,6 +75513,9 @@ }, "401": { "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -94670,13 +94668,106 @@ } } }, - "registry-package-updated": { + "registry-package-updated": { + "post": { + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/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#registry_package" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-registry-package-updated" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "registry_package", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "release-created": { "post": { - "summary": "This event occurs when there is activity relating to 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 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": [ { @@ -94741,7 +94832,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-release-created" } } } @@ -94754,7 +94845,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -94763,11 +94854,11 @@ } } }, - "release-created": { + "release-deleted": { "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": "A release, pre-release, or draft release was deleted.", + "operationId": "release/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -94834,7 +94925,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-created" + "$ref": "#/components/schemas/webhook-release-deleted" } } } @@ -94856,11 +94947,11 @@ } } }, - "release-deleted": { + "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 release, pre-release, or draft release was deleted.", - "operationId": "release/deleted", + "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" }, @@ -94927,7 +95018,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-deleted" + "$ref": "#/components/schemas/webhook-release-edited" } } } @@ -94949,11 +95040,11 @@ } } }, - "release-edited": { + "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": "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 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" }, @@ -95020,7 +95111,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-edited" + "$ref": "#/components/schemas/webhook-release-prereleased" } } } @@ -95042,11 +95133,11 @@ } } }, - "release-prereleased": { + "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": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", - "operationId": "release/prereleased", + "description": "A release, pre-release, or draft of a release was published.", + "operationId": "release/published", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -95113,7 +95204,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-release-published" } } } @@ -95135,11 +95226,11 @@ } } }, - "release-published": { + "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, pre-release, or draft of a release was published.", - "operationId": "release/published", + "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" }, @@ -95206,7 +95297,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-release-released" } } } @@ -95228,11 +95319,11 @@ } } }, - "release-released": { + "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 was published, or a pre-release was changed to a release.", - "operationId": "release/released", + "description": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -95299,7 +95390,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-release-unpublished" } } } @@ -95321,13 +95412,13 @@ } } }, - "release-unpublished": { + "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 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 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": [ { @@ -95392,7 +95483,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-repository-advisory-published" } } } @@ -95405,7 +95496,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "repository_advisory", "supported-webhook-types": [ "repository", "organization", @@ -95414,11 +95505,11 @@ } } }, - "repository-advisory-published": { + "repository-advisory-reported": { "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", + "description": "A private vulnerability report was submitted.", + "operationId": "repository-advisory/reported", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" }, @@ -95485,7 +95576,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-published" + "$ref": "#/components/schemas/webhook-repository-advisory-reported" } } } @@ -95507,13 +95598,13 @@ } } }, - "repository-advisory-reported": { + "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 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 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": [ { @@ -95578,7 +95669,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-reported" + "$ref": "#/components/schemas/webhook-repository-archived" } } } @@ -95591,8 +95682,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -95600,11 +95692,11 @@ } } }, - "repository-archived": { + "repository-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": "A repository was archived.", - "operationId": "repository/archived", + "description": "A repository was created.", + "operationId": "repository/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -95671,7 +95763,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-repository-created" } } } @@ -95694,11 +95786,11 @@ } } }, - "repository-created": { + "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 created.", - "operationId": "repository/created", + "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" }, @@ -95765,7 +95857,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-repository-deleted" } } } @@ -95788,11 +95880,101 @@ } } }, - "repository-deleted": { + "repository-dispatch-sample.collected": { + "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", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" + }, + "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-dispatch-sample" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_dispatch", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "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" }, @@ -95859,7 +96041,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-repository-edited" } } } @@ -95882,12 +96064,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": [ { @@ -95952,7 +96134,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-repository-import" } } } @@ -95965,18 +96147,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" }, @@ -96043,7 +96226,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-repository-privatized" } } } @@ -96066,12 +96249,13 @@ } } }, - "repository-import": { + "repository-publicized": { "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", + "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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -96136,7 +96320,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-import" + "$ref": "#/components/schemas/webhook-repository-publicized" } } } @@ -96149,19 +96333,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_import", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-privatized": { + "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 `private`.", - "operationId": "repository/privatized", + "description": "The name of a repository was changed.", + "operationId": "repository/renamed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -96228,7 +96414,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-repository-renamed" } } } @@ -96251,13 +96437,13 @@ } } }, - "repository-publicized": { + "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 visibility of a repository was changed to `public`.", - "operationId": "repository/publicized", + "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": [ { @@ -96322,7 +96508,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" } } } @@ -96335,9 +96521,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -96345,13 +96530,13 @@ } } }, - "repository-renamed": { + "repository-ruleset-deleted": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/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 deleted.", + "operationId": "repository-ruleset/deleted", "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": [ { @@ -96416,7 +96601,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" } } } @@ -96429,9 +96614,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -96439,11 +96623,11 @@ } } }, - "repository-ruleset-created": { + "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 created.", - "operationId": "repository-ruleset/created", + "description": "A repository ruleset was edited.", + "operationId": "repository-ruleset/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, @@ -96510,7 +96694,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" } } } @@ -96532,13 +96716,13 @@ } } }, - "repository-ruleset-deleted": { + "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 deleted.", - "operationId": "repository-ruleset/deleted", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/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": [ { @@ -96603,7 +96787,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-transferred" } } } @@ -96616,8 +96800,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -96625,13 +96810,13 @@ } } }, - "repository-ruleset-edited": { + "repository-unarchived": { "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": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", "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": [ { @@ -96696,7 +96881,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-unarchived" } } } @@ -96709,8 +96894,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -96718,13 +96904,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": [ { @@ -96789,7 +96975,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" } } } @@ -96802,23 +96988,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": [ { @@ -96883,7 +97067,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" } } } @@ -96896,21 +97080,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" }, @@ -96977,7 +97159,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" } } } @@ -96998,11 +97180,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" }, @@ -97069,7 +97251,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" } } } @@ -97090,13 +97272,13 @@ } } }, - "repository-vulnerability-alert-reopen": { + "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 previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", + "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": [ { @@ -97161,7 +97343,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" } } } @@ -97174,21 +97356,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": [ { @@ -97253,7 +97436,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" } } } @@ -97266,21 +97449,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": [ { @@ -97345,7 +97529,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" + } } } } @@ -97357,8 +97556,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -97367,13 +97567,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": [ { @@ -97438,22 +97638,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" - } + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" } } } @@ -97465,9 +97650,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -97476,11 +97660,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" }, @@ -97547,7 +97731,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -97569,11 +97753,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" }, @@ -97640,7 +97824,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -97662,11 +97846,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" }, @@ -97733,7 +97917,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -102256,6 +102440,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.", @@ -104332,6 +104524,30 @@ "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", + "example": 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", + "example": 10 + } + } + }, "code-security-configuration": { "type": "object", "description": "A code security configuration", @@ -108568,6 +108784,30 @@ "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", + "example": 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", + "example": 10 + } + } + }, "nullable-simple-repository": { "title": "Simple Repository", "description": "A GitHub repository.", @@ -109006,6 +109246,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": [ @@ -115335,6 +115579,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", @@ -118180,6 +118488,9 @@ }, { "$ref": "#/components/schemas/repository-rule-code-scanning" + }, + { + "$ref": "#/components/schemas/repository-rule-copilot-code-review" } ] }, @@ -120153,96 +120464,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", - "nullable": true - }, - "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.", @@ -120750,79 +120971,6 @@ "updated_at" ] }, - "project-column": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - }, - "cards_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" - }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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": { - "$ref": "#/components/schemas/nullable-simple-user" - } - }, - "required": [ - "permission", - "user" - ] - }, "rate-limit": { "title": "Rate Limit", "type": "object", @@ -121002,6 +121150,30 @@ "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", + "example": 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", + "example": 10 + } + } + }, "actions-cache-list": { "title": "Repository actions caches", "description": "Repository actions caches", @@ -123062,6 +123234,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -133385,6 +133558,11 @@ "type": "string", "nullable": true }, + "secret-scanning-alert-assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true + }, "secret-scanning-location": { "type": "object", "properties": { @@ -152099,6 +152277,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -152902,6 +153087,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -266659,6 +266851,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", @@ -266848,6 +267078,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", @@ -279356,6 +279624,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": [ { @@ -281834,6 +282112,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.", @@ -286550,6 +286849,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, @@ -286560,21 +287047,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", @@ -289331,94 +289836,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, @@ -289578,43 +289995,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": { @@ -302541,7 +302921,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": { @@ -310249,6 +310649,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.", @@ -310365,15 +310788,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", @@ -310405,15 +310819,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/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index ba0ae443b..b7a6e0fce 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -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 @@ -1497,6 +1495,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 @@ -5107,6 +5251,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 @@ -5395,6 +5685,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" @@ -5581,9 +5889,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': @@ -17711,6 +18017,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 @@ -19274,6 +19712,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" @@ -21445,179 +21884,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 - 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 - nullable: true - 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 @@ -21872,402 +22138,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 - example: Remaining tasks - type: string - 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.' - example: last - type: string - pattern: "^(?:first|last|after:\\d+)$" - 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 - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - example: write - type: string - nullable: true - 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 @@ -22831,6 +22701,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 @@ -44849,6 +44869,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" @@ -44928,6 +44949,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. @@ -44954,14 +44977,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 @@ -44979,7 +45014,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: @@ -48621,184 +48657,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) @@ -54766,6 +54624,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 @@ -70236,7 +70218,72 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + 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. + + 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 @@ -70244,10 +70291,11 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_vulnerability_alert + subcategory: secret_scanning_alert supported-webhook-types: - repository - organization + - app secret-scanning-alert-created: post: summary: |- @@ -70591,6 +70639,72 @@ x-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: |- @@ -73879,6 +73993,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 @@ -75631,6 +75752,26 @@ 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 + example: 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 + example: 10 code-security-configuration: type: object description: A code security configuration @@ -78943,6 +79084,26 @@ 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 + example: 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 + example: 10 nullable-simple-repository: title: Simple Repository description: A GitHub repository. @@ -79323,6 +79484,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: @@ -84423,6 +84588,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 @@ -86638,6 +86852,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 @@ -88213,74 +88428,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 - nullable: true - 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. @@ -88689,63 +88836,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 - example: https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - cards_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - example: 42 - type: integer - node_id: - type: string - example: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - example: Remaining tasks - type: string - created_at: - type: string - format: date-time - example: '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - example: '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: - "$ref": "#/components/schemas/nullable-simple-user" - required: - - permission - - user rate-limit: title: Rate Limit type: object @@ -88880,6 +88970,24 @@ 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 + example: 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 + example: 10 actions-cache-list: title: Repository actions caches description: Repository actions caches @@ -90452,6 +90560,7 @@ components: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true verification: @@ -98269,6 +98378,11 @@ components: be updated or deleted. type: string nullable: true + secret-scanning-alert-assignee: + description: The username of the user to assign to the alert. Set to `null` + to unassign the alert. + type: string + nullable: true secret-scanning-location: type: object properties: @@ -112551,6 +112665,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -113164,6 +113283,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -198804,6 +198928,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 @@ -198935,6 +199085,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 @@ -208977,6 +209153,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 @@ -211134,6 +211316,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. @@ -215071,6 +215269,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 @@ -215080,17 +215410,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: @@ -217472,84 +217814,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 @@ -217698,38 +217962,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: @@ -228856,6 +229088,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 @@ -235567,6 +235818,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 @@ -235668,13 +235938,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 @@ -235704,13 +235967,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/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 729ba38e5..2a2437bab 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/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." @@ -2157,6 +2153,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", @@ -7279,6 +7475,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", @@ -7639,6 +8035,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": { @@ -7885,10 +8310,7 @@ }, "examples": { "update-budget": { - "value": { - "message": "Budget successfully updated.", - "id": "550e8400-e29b-41d4-a716-446655440000" - } + "$ref": "#/components/examples/update-budget" } } } @@ -24427,50 +24849,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": { @@ -24481,6 +25035,9 @@ }, "401": { "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -24491,62 +25048,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": { @@ -24555,14 +25077,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" } } } @@ -24587,119 +25106,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": [ { @@ -24709,11 +25130,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": { @@ -24730,6 +25157,15 @@ } ] } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/per-page" } ], "responses": { @@ -24738,7 +25174,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": { @@ -26651,6 +27270,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -29639,252 +30261,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", - "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" - ] - } - }, - "nullable": true - }, - "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", @@ -30225,555 +30601,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", - "example": "Remaining tasks", - "type": "string" - } - }, - "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.", - "example": "last", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$" - } - }, - "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", - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "example": "write", - "type": "string" - } - }, - "nullable": true - }, - "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", @@ -31438,6 +31265,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", @@ -61772,6 +61811,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -61898,7 +61940,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" @@ -61933,6 +61975,9 @@ }, "resolution_comment": { "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + }, + "assignee": { + "$ref": "#/components/schemas/secret-scanning-alert-assignee" } }, "anyOf": [ @@ -61940,6 +61985,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -61949,6 +61999,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -61977,7 +62039,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" @@ -66886,254 +66948,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)", @@ -75394,120 +75208,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": { @@ -75518,6 +75513,9 @@ }, "401": { "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -94670,13 +94668,106 @@ } } }, - "registry-package-updated": { + "registry-package-updated": { + "post": { + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/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#registry_package" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-registry-package-updated" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "registry_package", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "release-created": { "post": { - "summary": "This event occurs when there is activity relating to 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 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": [ { @@ -94741,7 +94832,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-release-created" } } } @@ -94754,7 +94845,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -94763,11 +94854,11 @@ } } }, - "release-created": { + "release-deleted": { "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": "A release, pre-release, or draft release was deleted.", + "operationId": "release/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -94834,7 +94925,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-created" + "$ref": "#/components/schemas/webhook-release-deleted" } } } @@ -94856,11 +94947,11 @@ } } }, - "release-deleted": { + "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 release, pre-release, or draft release was deleted.", - "operationId": "release/deleted", + "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" }, @@ -94927,7 +95018,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-deleted" + "$ref": "#/components/schemas/webhook-release-edited" } } } @@ -94949,11 +95040,11 @@ } } }, - "release-edited": { + "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": "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 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" }, @@ -95020,7 +95111,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-edited" + "$ref": "#/components/schemas/webhook-release-prereleased" } } } @@ -95042,11 +95133,11 @@ } } }, - "release-prereleased": { + "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": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", - "operationId": "release/prereleased", + "description": "A release, pre-release, or draft of a release was published.", + "operationId": "release/published", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -95113,7 +95204,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-release-published" } } } @@ -95135,11 +95226,11 @@ } } }, - "release-published": { + "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, pre-release, or draft of a release was published.", - "operationId": "release/published", + "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" }, @@ -95206,7 +95297,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-release-released" } } } @@ -95228,11 +95319,11 @@ } } }, - "release-released": { + "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 was published, or a pre-release was changed to a release.", - "operationId": "release/released", + "description": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -95299,7 +95390,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-release-unpublished" } } } @@ -95321,13 +95412,13 @@ } } }, - "release-unpublished": { + "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 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 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": [ { @@ -95392,7 +95483,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-repository-advisory-published" } } } @@ -95405,7 +95496,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "repository_advisory", "supported-webhook-types": [ "repository", "organization", @@ -95414,11 +95505,11 @@ } } }, - "repository-advisory-published": { + "repository-advisory-reported": { "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", + "description": "A private vulnerability report was submitted.", + "operationId": "repository-advisory/reported", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" }, @@ -95485,7 +95576,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-published" + "$ref": "#/components/schemas/webhook-repository-advisory-reported" } } } @@ -95507,13 +95598,13 @@ } } }, - "repository-advisory-reported": { + "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 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 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": [ { @@ -95578,7 +95669,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-reported" + "$ref": "#/components/schemas/webhook-repository-archived" } } } @@ -95591,8 +95682,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -95600,11 +95692,11 @@ } } }, - "repository-archived": { + "repository-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": "A repository was archived.", - "operationId": "repository/archived", + "description": "A repository was created.", + "operationId": "repository/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -95671,7 +95763,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-repository-created" } } } @@ -95694,11 +95786,11 @@ } } }, - "repository-created": { + "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 created.", - "operationId": "repository/created", + "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" }, @@ -95765,7 +95857,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-repository-deleted" } } } @@ -95788,11 +95880,101 @@ } } }, - "repository-deleted": { + "repository-dispatch-sample.collected": { + "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", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" + }, + "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-dispatch-sample" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_dispatch", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "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" }, @@ -95859,7 +96041,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-repository-edited" } } } @@ -95882,12 +96064,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": [ { @@ -95952,7 +96134,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-repository-import" } } } @@ -95965,18 +96147,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" }, @@ -96043,7 +96226,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-repository-privatized" } } } @@ -96066,12 +96249,13 @@ } } }, - "repository-import": { + "repository-publicized": { "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", + "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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -96136,7 +96320,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-import" + "$ref": "#/components/schemas/webhook-repository-publicized" } } } @@ -96149,19 +96333,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_import", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-privatized": { + "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 `private`.", - "operationId": "repository/privatized", + "description": "The name of a repository was changed.", + "operationId": "repository/renamed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -96228,7 +96414,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-repository-renamed" } } } @@ -96251,13 +96437,13 @@ } } }, - "repository-publicized": { + "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 visibility of a repository was changed to `public`.", - "operationId": "repository/publicized", + "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": [ { @@ -96322,7 +96508,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" } } } @@ -96335,9 +96521,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -96345,13 +96530,13 @@ } } }, - "repository-renamed": { + "repository-ruleset-deleted": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/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 deleted.", + "operationId": "repository-ruleset/deleted", "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": [ { @@ -96416,7 +96601,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" } } } @@ -96429,9 +96614,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -96439,11 +96623,11 @@ } } }, - "repository-ruleset-created": { + "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 created.", - "operationId": "repository-ruleset/created", + "description": "A repository ruleset was edited.", + "operationId": "repository-ruleset/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, @@ -96510,7 +96694,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" } } } @@ -96532,13 +96716,13 @@ } } }, - "repository-ruleset-deleted": { + "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 deleted.", - "operationId": "repository-ruleset/deleted", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/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": [ { @@ -96603,7 +96787,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-transferred" } } } @@ -96616,8 +96800,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -96625,13 +96810,13 @@ } } }, - "repository-ruleset-edited": { + "repository-unarchived": { "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": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", "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": [ { @@ -96696,7 +96881,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-unarchived" } } } @@ -96709,8 +96894,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -96718,13 +96904,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": [ { @@ -96789,7 +96975,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" } } } @@ -96802,23 +96988,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": [ { @@ -96883,7 +97067,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" } } } @@ -96896,21 +97080,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" }, @@ -96977,7 +97159,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" } } } @@ -96998,11 +97180,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" }, @@ -97069,7 +97251,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" } } } @@ -97090,13 +97272,13 @@ } } }, - "repository-vulnerability-alert-reopen": { + "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 previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", + "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": [ { @@ -97161,7 +97343,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" } } } @@ -97174,21 +97356,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": [ { @@ -97253,7 +97436,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" } } } @@ -97266,21 +97449,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": [ { @@ -97345,7 +97529,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" + } } } } @@ -97357,8 +97556,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -97367,13 +97567,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": [ { @@ -97438,22 +97638,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" - } + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" } } } @@ -97465,9 +97650,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -97476,11 +97660,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" }, @@ -97547,7 +97731,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -97569,11 +97753,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" }, @@ -97640,7 +97824,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -97662,11 +97846,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" }, @@ -97733,7 +97917,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } @@ -102256,6 +102440,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.", @@ -104332,6 +104524,30 @@ "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", + "example": 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", + "example": 10 + } + } + }, "code-security-configuration": { "type": "object", "description": "A code security configuration", @@ -108568,6 +108784,30 @@ "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", + "example": 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", + "example": 10 + } + } + }, "nullable-simple-repository": { "title": "Simple Repository", "description": "A GitHub repository.", @@ -109006,6 +109246,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": [ @@ -115335,6 +115579,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", @@ -118180,6 +118488,9 @@ }, { "$ref": "#/components/schemas/repository-rule-code-scanning" + }, + { + "$ref": "#/components/schemas/repository-rule-copilot-code-review" } ] }, @@ -120153,96 +120464,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", - "nullable": true - }, - "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.", @@ -120750,79 +120971,6 @@ "updated_at" ] }, - "project-column": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - }, - "cards_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" - }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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": { - "$ref": "#/components/schemas/nullable-simple-user" - } - }, - "required": [ - "permission", - "user" - ] - }, "rate-limit": { "title": "Rate Limit", "type": "object", @@ -121002,6 +121150,30 @@ "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", + "example": 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", + "example": 10 + } + } + }, "actions-cache-list": { "title": "Repository actions caches", "description": "Repository actions caches", @@ -123062,6 +123234,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -133385,6 +133558,11 @@ "type": "string", "nullable": true }, + "secret-scanning-alert-assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true + }, "secret-scanning-location": { "type": "object", "properties": { @@ -152099,6 +152277,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -152902,6 +153087,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -266659,6 +266851,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", @@ -266848,6 +267078,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", @@ -279356,6 +279624,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": [ { @@ -281834,6 +282112,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.", @@ -286550,6 +286849,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, @@ -286560,21 +287047,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", @@ -289331,94 +289836,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, @@ -289578,43 +289995,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": { @@ -302541,7 +302921,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": { @@ -310249,6 +310649,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.", @@ -310365,15 +310788,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", @@ -310405,15 +310819,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/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index ba0ae443b..b7a6e0fce 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/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 @@ -1497,6 +1495,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 @@ -5107,6 +5251,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 @@ -5395,6 +5685,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" @@ -5581,9 +5889,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': @@ -17711,6 +18017,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 @@ -19274,6 +19712,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" @@ -21445,179 +21884,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 - 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 - nullable: true - 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 @@ -21872,402 +22138,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 - example: Remaining tasks - type: string - 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.' - example: last - type: string - pattern: "^(?:first|last|after:\\d+)$" - 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 - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - example: write - type: string - nullable: true - 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 @@ -22831,6 +22701,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 @@ -44849,6 +44869,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" @@ -44928,6 +44949,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. @@ -44954,14 +44977,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 @@ -44979,7 +45014,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: @@ -48621,184 +48657,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) @@ -54766,6 +54624,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 @@ -70236,7 +70218,72 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + 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. + + 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 @@ -70244,10 +70291,11 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_vulnerability_alert + subcategory: secret_scanning_alert supported-webhook-types: - repository - organization + - app secret-scanning-alert-created: post: summary: |- @@ -70591,6 +70639,72 @@ x-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: |- @@ -73879,6 +73993,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 @@ -75631,6 +75752,26 @@ 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 + example: 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 + example: 10 code-security-configuration: type: object description: A code security configuration @@ -78943,6 +79084,26 @@ 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 + example: 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 + example: 10 nullable-simple-repository: title: Simple Repository description: A GitHub repository. @@ -79323,6 +79484,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: @@ -84423,6 +84588,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 @@ -86638,6 +86852,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 @@ -88213,74 +88428,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 - nullable: true - 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. @@ -88689,63 +88836,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 - example: https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - cards_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - example: 42 - type: integer - node_id: - type: string - example: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - example: Remaining tasks - type: string - created_at: - type: string - format: date-time - example: '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - example: '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: - "$ref": "#/components/schemas/nullable-simple-user" - required: - - permission - - user rate-limit: title: Rate Limit type: object @@ -88880,6 +88970,24 @@ 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 + example: 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 + example: 10 actions-cache-list: title: Repository actions caches description: Repository actions caches @@ -90452,6 +90560,7 @@ components: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true verification: @@ -98269,6 +98378,11 @@ components: be updated or deleted. type: string nullable: true + secret-scanning-alert-assignee: + description: The username of the user to assign to the alert. Set to `null` + to unassign the alert. + type: string + nullable: true secret-scanning-location: type: object properties: @@ -112551,6 +112665,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -113164,6 +113283,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -198804,6 +198928,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 @@ -198935,6 +199085,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 @@ -208977,6 +209153,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 @@ -211134,6 +211316,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. @@ -215071,6 +215269,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 @@ -215080,17 +215410,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: @@ -217472,84 +217814,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 @@ -217698,38 +217962,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: @@ -228856,6 +229088,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 @@ -235567,6 +235818,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 @@ -235668,13 +235938,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 @@ -235704,13 +235967,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/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 5a35ecf80..3db5caa7f 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -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." @@ -4718,6 +4714,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.", @@ -5703,6 +5707,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.", @@ -6542,6 +6554,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.", @@ -7012,6 +7032,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.", @@ -9037,6 +9065,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.", @@ -10073,6 +10109,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.", @@ -11026,6 +11070,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.", @@ -11690,6 +11742,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.", @@ -16605,17 +16665,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": [ { @@ -16626,34 +16686,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": { @@ -16662,334 +16694,928 @@ "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", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "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", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "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", + "example": 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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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", + "example": 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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "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", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "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" + } + ] } } } @@ -52307,6 +52933,572 @@ } } }, + "/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", + "example": 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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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", + "example": 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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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", @@ -53594,6 +54786,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": { @@ -53683,6 +54916,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": [ @@ -54329,7 +55566,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" + ] + } + } } } } @@ -102968,6 +104220,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.", @@ -103968,6 +105228,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.", @@ -138995,19 +140263,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": [ { @@ -139019,15 +140285,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.", @@ -139038,9 +140295,749 @@ } } ], + "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.", + "example": "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", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was last updated." + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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": { @@ -139240,21 +141237,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", @@ -161444,6 +163459,35 @@ ] } } + }, + { + "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." + } + } + } + } } ] } @@ -166103,6 +168147,35 @@ ] } } + }, + { + "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." + } + } + } + } } ] } @@ -168149,6 +170222,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.", @@ -184462,17 +186558,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": [ { @@ -184520,42 +186616,28 @@ "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", + "example": 1296269 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "type": "string" - }, - "body": { "type": "string", - "nullable": true - }, - "number": { - "type": "integer" + "example": "Hello-World" }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -184679,55 +186761,538 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "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", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "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", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, "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", + "example": "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", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# 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", + "format": "uri", + "nullable": true } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "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" ] } }, @@ -184735,17 +187300,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=", @@ -184765,1385 +187324,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", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "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", - "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" - ] - } - }, - "nullable": true - }, - "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", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "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", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# 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", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "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" + } } } ] @@ -187605,164 +188876,465 @@ "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", - "example": "https://api.github.com/projects/columns/367" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - }, - "cards_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" - }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "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", - "example": "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" } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { + }, + "X-RateLimit-Remaining": { + "example": 4999, "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-Reset": { + "example": 1590701888, + "schema": { + "type": "integer", + "format": "timestamp" } } } }, - "401": { - "description": "Requires authentication", + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -187791,2870 +189363,741 @@ "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", - "example": "Remaining tasks", - "type": "string" - } - }, - "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", + "example": 1296269 + }, + "node_id": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "project_url": { + "name": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" + "example": "Hello-World" }, - "cards_url": { + "full_name": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" + "example": "octocat/Hello-World" }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "node_id": { + "private": { + "type": "boolean" + }, + "html_url": { "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true }, - "created_at": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "updated_at": { + "archive_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "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" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "url": { - "type": "string" + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "documentation_url": { - "type": "string" + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "url": { - "type": "string" + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "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" + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, - "documentation_url": { - "type": "string" + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, - "url": { - "type": "string" + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, - "documentation_url": { - "type": "string" + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "url": { - "type": "string" + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "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.", - "example": "last", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$" - } - }, - "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" + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, - "documentation_url": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "url": { - "type": "string" + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "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" + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "documentation_url": { - "type": "string" + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "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" + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - "documentation_url": { - "type": "string" + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, - "url": { - "type": "string" + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - "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" + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - "documentation_url": { - "type": "string" + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, - "url": { - "type": "string" + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, - "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" + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, - "documentation_url": { - "type": "string" + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, - "documentation_url": { - "type": "string" + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, - "url": { - "type": "string" + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, - "documentation_url": { - "type": "string" + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" }, - "url": { - "type": "string" + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, - "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", - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "example": "write", - "type": "string" - } - }, - "nullable": true - }, - "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" + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, - "documentation_url": { - "type": "string" + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, - "url": { - "type": "string" + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, - "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" + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, - "documentation_url": { - "type": "string" + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, - "documentation_url": { - "type": "string" + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" }, - "url": { - "type": "string" + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, - "documentation_url": { - "type": "string" + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" }, - "url": { - "type": "string" + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true }, - "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" + "language": { + "type": "string", + "nullable": true }, - "documentation_url": { - "type": "string" + "forks_count": { + "type": "integer", + "example": 9 }, - "url": { - "type": "string" + "stargazers_count": { + "type": "integer", + "example": 80 }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "watchers_count": { + "type": "integer", + "example": 80 }, - "documentation_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", + "example": 108 }, - "url": { - "type": "string" + "default_branch": { + "type": "string", + "example": "master" }, - "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" + "open_issues_count": { + "type": "integer", + "example": 0 }, - "documentation_url": { - "type": "string" + "is_template": { + "type": "boolean", + "example": true }, - "errors": { + "topics": { "type": "array", "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "type": "string" + }, + "example": [ + "octocat", + "atom", + "electron", + "API" + ] }, - "documentation_url": { - "type": "string" + "has_issues": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "has_projects": { + "type": "boolean", + "example": true }, - "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" + "has_wiki": { + "type": "boolean", + "example": true }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean", + "example": true + }, + "has_discussions": { + "type": "boolean", + "example": 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", + "example": "public" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z" + }, + "permissions": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "admin": { + "type": "boolean" }, - "email": { - "nullable": true, - "type": "string" + "maintain": { + "type": "boolean" }, - "login": { - "type": "string", - "example": "octocat" + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" }, + "pull": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "allow_rebase_merge": { + "type": "boolean", + "example": true + }, + "template_repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "format": "int64", - "example": 1 + "format": "int64" }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "type": { + "name": { + "description": "The name of the repository.", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "example": "Team Environment" }, - "starred_at": { + "full_name": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "example": "octocat/Hello-World" }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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", + "license": { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" + "key": { + "type": "string", + "example": "mit" }, - "reset": { - "type": "integer" + "name": { + "type": "string", + "example": "MIT License" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "graphql": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" }, - "remaining": { - "type": "integer" + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" }, - "reset": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" }, - "used": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "limit", - "remaining", - "reset", - "used" - ] + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true }, - "search": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] + "forks": { + "type": "integer" }, - "code_search": { - "title": "Rate Limit", + "permissions": { "type": "object", "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" + "admin": { + "type": "boolean" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "source_import": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "pull": { + "type": "boolean" }, - "remaining": { - "type": "integer" + "triage": { + "type": "boolean" }, - "reset": { - "type": "integer" + "push": { + "type": "boolean" }, - "used": { - "type": "integer" + "maintain": { + "type": "boolean" } }, "required": [ - "limit", - "remaining", - "reset", - "used" + "admin", + "pull", + "push" ] }, - "integration_manifest": { - "title": "Rate Limit", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "limit": { - "type": "integer" + "name": { + "nullable": true, + "type": "string" }, - "remaining": { - "type": "integer" + "email": { + "nullable": true, + "type": "string" }, - "reset": { - "type": "integer" + "login": { + "type": "string", + "example": "octocat" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_upload": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "remaining": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "reset": { - "type": "integer" + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "actions_runner_registration": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "remaining": { - "type": "integer" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "reset": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "scim": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "remaining": { - "type": "integer" + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "reset": { - "type": "integer" + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_snapshots": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "remaining": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "reset": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_sbom": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, - "remaining": { - "type": "integer" + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "reset": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_autofix": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "type": { + "type": "string", + "example": "User" }, - "remaining": { - "type": "integer" + "site_admin": { + "type": "boolean" }, - "reset": { - "type": "integer" + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" }, - "used": { - "type": "integer" + "user_view_type": { + "type": "string", + "example": "public" } }, "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", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 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", - "example": 108 - }, - "default_branch": { - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "example": true - }, - "has_projects": { - "type": "boolean", - "example": true - }, - "has_wiki": { - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "example": true - }, - "has_discussions": { - "type": "boolean", - "example": 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", - "example": "public" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "example": true - }, - "template_repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "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": { @@ -198509,6 +197952,608 @@ } } }, + "/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", + "example": 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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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", + "example": 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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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", @@ -224334,6 +224379,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -224354,6 +224400,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -242552,6 +242599,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -242572,6 +242620,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -278220,6 +278269,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -278240,6 +278290,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -283974,6 +284025,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -283994,6 +284046,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289303,6 +289356,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289323,6 +289377,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289849,6 +289904,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289869,6 +289925,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -290419,6 +290476,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -290439,6 +290497,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -324211,6 +324270,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.", @@ -406452,6 +406519,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -406472,6 +406540,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -437285,6 +437354,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -437305,6 +437375,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -468363,6 +468434,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.", @@ -470603,7 +470697,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" @@ -470673,6 +470767,11 @@ "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", "type": "string", "nullable": true + }, + "assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true } }, "anyOf": [ @@ -470680,6 +470779,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -470689,6 +470793,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -471665,7 +471781,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 + } } } } @@ -471679,7 +471815,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", @@ -498900,6 +499036,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -499112,6 +499249,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -512070,17 +512208,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": [ { @@ -512119,42 +512257,28 @@ "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", + "example": 1296269 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "type": "string" - }, - "body": { "type": "string", - "nullable": true - }, - "number": { - "type": "integer" + "example": "Hello-World" }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -512278,55 +512402,538 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "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", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "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", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, "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", + "example": "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", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# 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", + "format": "uri", + "nullable": true + } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "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" ] } }, @@ -512334,17 +512941,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=", @@ -512364,1564 +512965,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", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "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", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# 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", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "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" + } } } ] @@ -540360,6 +539494,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.", @@ -589101,6 +588243,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.", @@ -595498,51 +594648,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": { @@ -595733,7 +595112,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", @@ -595743,37 +595155,509 @@ "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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.", + "example": "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", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was last updated." + } + }, + "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": { @@ -647113,6 +646997,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -649494,6 +649385,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -757124,6 +757022,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.", @@ -759716,6 +759622,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.", @@ -762215,6 +762129,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.", @@ -764714,6 +764636,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.", @@ -767345,6 +767275,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.", @@ -769983,6 +769921,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.", @@ -774244,6 +774190,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.", @@ -1168125,949 +1168079,4357 @@ ] } }, - "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." + }, + "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" + } + } + } + } + } + } + } + } + } + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "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", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": 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", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "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", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "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", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": 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", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "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", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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", @@ -1169196,7 +1172558,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1169211,8 +1172573,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1169220,13 +1172583,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": [ { @@ -1169291,200 +1172654,180 @@ "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": { + "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", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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", + "nullable": true + }, + "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", + "nullable": true, + "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", @@ -1170992,7 +1174335,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1171008,23 +1174351,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": [ { @@ -1171089,15 +1174430,191 @@ "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", + "nullable": true + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "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).\"", @@ -1172604,6 +1176121,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1172619,21 +1176137,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" }, @@ -1172700,13 +1176216,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": { @@ -1174405,11 +1177921,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" }, @@ -1174476,13 +1177992,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": { @@ -1174493,9 +1178009,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1174515,10 +1178028,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": "string", - "nullable": true - }, "dismiss_reason": { "type": "string" }, @@ -1174614,9 +1178123,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1174656,7 +1178162,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1176163,279 +1179670,855 @@ "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", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "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": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { + "type": "string", + "description": "The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true + }, + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1177944,8 +1182027,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1177959,21 +1182041,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": [ { @@ -1178038,179 +1182121,630 @@ "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": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", - "type": "object", + "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", + "description": "The reason for resolving the alert.", "nullable": true, - "required": [ - "login", - "id" - ], + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "format": "uri" + "example": "octocat" }, - "deleted": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "email": { + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "gravatar_id": { - "type": "string" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "html_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "login": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { "name": { + "nullable": true, "type": "string" }, - "node_id": { + "email": { + "nullable": true, "type": "string" }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "example": "User" }, "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, "starred_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "example": "User" }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - }, - "external_identifier": { - "type": "string" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "external_reference": { + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "nullable": true, - "format": "uri" - }, - "fix_reason": { - "type": "string" + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "fixed_at": { + "push_protection_bypass_request_comment": { "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true }, - "node_id": { - "type": "string" + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true }, - "number": { - "type": "integer" + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true }, - "severity": { - "type": "string" + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" - ] + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true } } }, @@ -1179721,8 +1184255,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1179736,21 +1184269,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": [ { @@ -1179815,7 +1184349,7 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { @@ -1180442,74 +1184976,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", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1180531,6 +1184997,314 @@ "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.", + "example": "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", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ] + } + } + }, "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.", @@ -1181947,10 +1186721,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" + } + } } } } @@ -1181962,8 +1186911,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1181972,13 +1186922,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": [ { @@ -1182043,13 +1186993,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": { @@ -1182670,6 +1187620,74 @@ } } }, + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1182691,314 +1187709,6 @@ "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.", - "example": "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", - "example": "/example/secrets.txt" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "example": "/example/Home.md" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082" - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussion-4566270" - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } - ] - } - } - }, "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.", @@ -1184415,185 +1189125,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" - } - } } } } @@ -1184605,9 +1189140,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1184616,11 +1189150,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" }, @@ -1184687,13 +1189221,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": { @@ -1186844,11 +1191378,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" }, @@ -1186915,13 +1191449,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": { @@ -1189072,11 +1193606,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" }, @@ -1189143,13 +1193677,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": { @@ -1189770,6 +1194304,130 @@ } } }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "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/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index e26d2a991..58e913ad7 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -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 - - &40 + - &45 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 - - &41 + - &46 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 - - &48 + - &52 name: direction description: The direction to sort the results by. in: query @@ -679,7 +677,7 @@ paths: required: - vector_string - score - cvss_severities: &50 + cvss_severities: &54 type: object nullable: true properties: @@ -719,7 +717,7 @@ paths: required: - vector_string - score - epss: &51 + epss: &55 type: object nullable: true readOnly: true @@ -857,7 +855,7 @@ paths: - subscriptions_url - type - url - type: &304 + type: &311 type: string description: The type of credit the user is receiving. enum: @@ -990,7 +988,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &113 + schema: &119 title: Validation Error Simple description: Validation Error Simple type: object @@ -1023,7 +1021,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &637 + - &641 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1141,7 +1139,7 @@ paths: GitHub. type: object nullable: true - properties: &67 + properties: &71 id: description: Unique identifier of the GitHub app example: 37 @@ -1274,7 +1272,7 @@ paths: about itself. example: 5 type: integer - required: &68 + required: &72 - id - node_id - owner @@ -1579,7 +1577,7 @@ paths: schema: type: integer default: 30 - - &197 + - &203 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 @@ -1595,7 +1593,7 @@ paths: application/json: schema: type: array - items: &198 + items: &204 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1675,7 +1673,7 @@ paths: - installation_id - repository_id examples: - default: &199 + default: &205 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1734,7 +1732,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &112 + schema: &118 title: Validation Error description: Validation Error type: object @@ -1803,7 +1801,7 @@ paths: description: Response content: application/json: - schema: &200 + schema: &206 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1917,7 +1915,7 @@ paths: - request - response examples: - default: &201 + default: &207 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2118,7 +2116,7 @@ paths: parameters: - *17 - *19 - - &72 + - &76 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) @@ -2208,6 +2206,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 @@ -2693,7 +2698,7 @@ paths: suspended_at: suspended_by: headers: - Link: &54 + Link: &58 example: ; rel="next", ; rel="last" schema: @@ -2882,11 +2887,11 @@ paths: - selected repositories: type: array - items: &66 + items: &70 title: Repository description: A repository on GitHub. type: object - properties: &270 + properties: &276 id: description: Unique identifier of the repository example: 42 @@ -2906,7 +2911,7 @@ paths: title: License Simple description: License Simple type: object - properties: &83 + properties: &87 key: type: string example: mit @@ -2928,7 +2933,7 @@ paths: html_url: type: string format: uri - required: &84 + required: &88 - key - name - url @@ -3324,7 +3329,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &271 + required: &277 - archive_url - assignees_url - blobs_url @@ -5111,7 +5116,7 @@ paths: responses: '202': *39 '422': *7 - '500': &103 + '500': &109 description: Internal Error content: application/json: @@ -7026,6 +7031,164 @@ 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: + - &40 + 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: &41 + 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 + example: 14 + examples: + default: &42 + value: + max_cache_retention_days: 80 + '403': *29 + '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: + - *40 + requestBody: + required: true + content: + application/json: + schema: *41 + examples: + selected_actions: *42 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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: + - *40 + responses: + '200': + description: Response + content: + application/json: + schema: &43 + 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 + example: 10 + examples: + default: &44 + value: + max_cache_size_gb: 150 + '403': *29 + '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: + - *40 + requestBody: + required: true + content: + application/json: + schema: *43 + examples: + selected_actions: *44 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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 @@ -7042,13 +7205,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise parameters: - - &42 - name: enterprise - description: The slug version of the enterprise name. - in: path - required: true - schema: - type: string + - *40 - name: per_page in: query description: The number of results per page (max 100). For more information, @@ -7057,8 +7214,8 @@ paths: schema: type: integer default: 30 - - *40 - - *41 + - *45 + - *46 responses: '200': description: Response @@ -7066,7 +7223,7 @@ paths: application/json: schema: type: array - items: &43 + items: &47 type: object description: A code security configuration properties: @@ -7357,7 +7514,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise parameters: - - *42 + - *40 requestBody: required: true content: @@ -7435,7 +7592,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &171 + code_scanning_options: &177 type: object description: Security Configuration feature options for code scanning nullable: true @@ -7452,7 +7609,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &46 + code_scanning_default_setup_options: &50 type: object description: Feature options for code scanning default setup nullable: true @@ -7569,9 +7726,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *43 + schema: *47 examples: - default: &44 + default: &48 value: id: 1325 target_type: enterprise @@ -7623,13 +7780,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise parameters: - - *42 + - *40 responses: '200': description: Response content: application/json: - schema: &173 + schema: &179 type: array description: A list of default code security configurations items: @@ -7643,9 +7800,9 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *43 + configuration: *47 examples: - default: &174 + default: &180 value: - default_for_new_repos: public configuration: @@ -7733,8 +7890,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise parameters: - - *42 - - &45 + - *40 + - &49 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -7746,9 +7903,9 @@ paths: description: Response content: application/json: - schema: *43 + schema: *47 examples: - default: *44 + default: *48 '304': *37 '403': *29 '404': *6 @@ -7772,8 +7929,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: - - *42 - - *45 + - *40 + - *49 requestBody: required: true content: @@ -7852,7 +8009,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *46 + code_scanning_default_setup_options: *50 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -7940,13 +8097,13 @@ paths: description: Response content: application/json: - schema: *43 + schema: *47 examples: - default: *44 + default: *48 '304': *37 '403': *29 '404': *6 - '409': &47 + '409': &51 description: Conflict content: application/json: @@ -7973,15 +8130,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise parameters: - - *42 - - *45 + - *40 + - *49 responses: - '204': &175 + '204': &181 description: A header with no content is returned. '400': *14 '403': *29 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8005,8 +8162,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories parameters: - - *42 - - *45 + - *40 + - *49 requestBody: required: true content: @@ -8033,7 +8190,7 @@ paths: '202': *39 '403': *29 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -8057,8 +8214,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: - - *42 - - *45 + - *40 + - *49 requestBody: required: true content: @@ -8098,12 +8255,12 @@ paths: - none - private_and_internal - public - configuration: *43 + configuration: *47 examples: default: value: default_for_new_repos: all - configuration: &172 + configuration: &178 value: id: 1325 target_type: organization @@ -8159,8 +8316,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: - - *42 - - *45 + - *40 + - *49 - 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)." @@ -8169,8 +8326,8 @@ paths: schema: type: integer default: 30 - - *40 - - *41 + - *45 + - *46 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -8188,7 +8345,7 @@ paths: application/json: schema: type: array - items: &176 + items: &182 type: object description: Repositories associated with a code security configuration and attachment status @@ -8206,11 +8363,11 @@ paths: - failed - updating - removed_by_enterprise - repository: &53 + repository: &57 title: Simple Repository description: A GitHub repository. type: object - properties: &100 + properties: &106 id: type: integer format: int64 @@ -8437,7 +8594,7 @@ paths: format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. - required: &101 + required: &107 - archive_url - assignees_url - blobs_url @@ -8489,7 +8646,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &177 + repository: &183 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -8582,8 +8739,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - - *42 - - &182 + - *40 + - &188 name: state in: query description: |- @@ -8592,7 +8749,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &183 + - &189 name: severity in: query description: |- @@ -8601,7 +8758,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &184 + - &190 name: ecosystem in: query description: |- @@ -8610,14 +8767,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &185 + - &191 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 - - &186 + - &192 name: epss_percentage in: query description: |- @@ -8629,7 +8786,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 - - &475 + - &479 name: has in: query description: |- @@ -8643,7 +8800,7 @@ paths: type: string enum: - patch - - &187 + - &193 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -8653,7 +8810,7 @@ paths: enum: - development - runtime - - &188 + - &194 name: sort in: query description: |- @@ -8668,9 +8825,9 @@ paths: - updated - epss_percentage default: created - - *48 - - *40 - - *41 + - *52 + - *45 + - *46 - *17 responses: '200': @@ -8679,11 +8836,11 @@ paths: application/json: schema: type: array - items: &189 + items: &195 type: object description: A Dependabot alert. properties: - number: &161 + number: &167 type: integer description: The security alert number. readOnly: true @@ -8701,7 +8858,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: &49 + package: &53 type: object description: Details for the vulnerable package. readOnly: true @@ -8745,7 +8902,7 @@ paths: - unknown - direct - transitive - security_advisory: &476 + security_advisory: &480 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -8775,13 +8932,13 @@ paths: description: Vulnerable version range information for the advisory. readOnly: true - items: &52 + items: &56 type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: - package: *49 + package: *53 severity: type: string description: The severity of the vulnerability. @@ -8847,8 +9004,8 @@ paths: - score - vector_string additionalProperties: false - cvss_severities: *50 - epss: *51 + cvss_severities: *54 + epss: *55 cwes: type: array description: Details for the advisory pertaining to Common @@ -8947,30 +9104,30 @@ paths: - updated_at - withdrawn_at additionalProperties: false - security_vulnerability: *52 - url: &164 + security_vulnerability: *56 + url: &170 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &165 + html_url: &171 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &162 + created_at: &168 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: &163 + updated_at: &169 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: &167 + dismissed_at: &173 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -9000,21 +9157,21 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: &166 + fixed_at: &172 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - auto_dismissed_at: &477 + auto_dismissed_at: &481 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - repository: *53 + repository: *57 required: - number - state @@ -9033,7 +9190,7 @@ paths: - repository additionalProperties: false examples: - default: &190 + default: &196 value: - number: 2 state: dismissed @@ -9372,7 +9529,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams parameters: - - *42 + - *40 - *17 - *19 responses: @@ -9382,7 +9539,7 @@ paths: application/json: schema: type: array - items: &55 + items: &59 title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -9440,7 +9597,7 @@ paths: - updated_at - group_id examples: - default: &56 + default: &60 value: - id: 1 name: Justice League @@ -9453,7 +9610,7 @@ paths: created_at: '2019-01-26T19:01:12Z' updated_at: '2019-01-26T19:14:43Z' headers: - Link: *54 + Link: *58 '403': *29 x-github: githubCloudOnly: false @@ -9471,7 +9628,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#create-an-enterprise-team parameters: - - *42 + - *40 requestBody: required: true content: @@ -9526,9 +9683,9 @@ paths: description: Response content: application/json: - schema: *55 + schema: *59 examples: - default: *56 + default: *60 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9545,8 +9702,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - - *42 - - &57 + - *40 + - &61 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -9565,7 +9722,7 @@ paths: type: array items: *4 examples: - default: &58 + default: &62 value: - login: octocat id: 1 @@ -9586,7 +9743,7 @@ paths: type: User site_admin: false headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9603,8 +9760,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - - *42 - - *57 + - *40 + - *61 requestBody: required: true content: @@ -9635,7 +9792,7 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9652,8 +9809,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - - *42 - - *57 + - *40 + - *61 requestBody: required: true content: @@ -9684,7 +9841,7 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9701,9 +9858,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - - *42 - - *57 - - &59 + - *40 + - *61 + - &63 name: username description: The handle for the GitHub user account. in: path @@ -9717,7 +9874,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &60 + exampleKey1: &64 value: login: octocat id: 1 @@ -9752,9 +9909,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - - *42 - - *57 - - *59 + - *40 + - *61 + - *63 responses: '201': description: Successfully added team member @@ -9762,7 +9919,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *60 + exampleKey1: *64 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9779,9 +9936,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - - *42 - - *57 - - *59 + - *40 + - *61 + - *63 responses: '204': description: Response @@ -9802,8 +9959,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments parameters: - - *42 - - *57 + - *40 + - *61 - *17 - *19 responses: @@ -9813,11 +9970,11 @@ paths: application/json: schema: type: array - items: &61 + items: &65 title: Organization Simple description: A GitHub organization. type: object - properties: &179 + properties: &185 login: type: string example: github @@ -9858,7 +10015,7 @@ paths: type: string example: A great organization nullable: true - required: &180 + required: &186 - login - url - id @@ -9872,7 +10029,7 @@ paths: - avatar_url - description examples: - default: &62 + default: &66 value: login: github id: 1 @@ -9902,8 +10059,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments parameters: - - *42 - - *57 + - *40 + - *61 requestBody: required: true content: @@ -9931,9 +10088,9 @@ paths: application/json: schema: type: array - items: *61 + items: *65 examples: - default: &99 + default: &103 value: - login: github id: 1 @@ -9963,8 +10120,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments parameters: - - *42 - - *57 + - *40 + - *61 requestBody: required: true content: @@ -10004,9 +10161,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment parameters: - - *42 - - *57 - - &63 + - *40 + - *61 + - &67 name: org description: The organization name. The name is not case sensitive. in: path @@ -10018,9 +10175,9 @@ paths: description: The team is assigned to the organization content: application/json: - schema: *61 + schema: *65 examples: - default: *62 + default: *66 '404': description: The team is not assigned to the organization x-github: @@ -10038,17 +10195,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment parameters: - - *42 - - *57 - - *63 + - *40 + - *61 + - *67 responses: '201': description: Successfully assigned the enterprise team to the organization. content: application/json: - schema: *61 + schema: *65 examples: - default: *62 + default: *66 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10064,9 +10221,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment parameters: - - *42 - - *57 - - *63 + - *40 + - *61 + - *67 responses: '204': description: Successfully unassigned the enterprise team from the organization. @@ -10089,8 +10246,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - - *42 - - &64 + - *40 + - &68 name: team_slug description: The slug of the team name. in: path @@ -10102,11 +10259,11 @@ paths: description: Response content: application/json: - schema: *55 + schema: *59 examples: - default: *56 + default: *60 headers: - Link: *54 + Link: *58 '403': *29 x-github: githubCloudOnly: false @@ -10123,8 +10280,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - - *42 - - *64 + - *40 + - *68 requestBody: required: true content: @@ -10179,11 +10336,11 @@ paths: description: Response content: application/json: - schema: *55 + schema: *59 examples: - default: *56 + default: *60 headers: - Link: *54 + Link: *58 '403': *29 x-github: githubCloudOnly: false @@ -10203,8 +10360,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - - *42 - - *64 + - *40 + - *68 responses: '204': description: Response @@ -10242,7 +10399,7 @@ paths: application/json: schema: type: array - items: &94 + items: &98 title: Event description: Event type: object @@ -10252,7 +10409,7 @@ paths: type: type: string nullable: true - actor: &65 + actor: &69 title: Actor description: Actor type: object @@ -10292,18 +10449,18 @@ paths: - id - name - url - org: *65 + org: *69 payload: type: object properties: action: type: string - issue: &82 + issue: &86 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &526 + properties: &530 id: type: integer format: int64 @@ -10415,7 +10572,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &256 + properties: &262 url: type: string format: uri @@ -10485,7 +10642,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &257 + required: &263 - closed_issues - creator - description @@ -10564,7 +10721,7 @@ paths: timeline_url: type: string format: uri - type: &219 + type: &225 title: Issue Type description: The type of issue. type: object @@ -10613,7 +10770,7 @@ paths: - node_id - name - description - repository: *66 + repository: *70 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -10623,9 +10780,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 - author_association: &69 + properties: *71 + required: *72 + author_association: &73 title: author_association type: string example: OWNER @@ -10639,7 +10796,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &70 + reactions: &74 title: Reaction Rollup type: object properties: @@ -10675,7 +10832,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &649 + sub_issues_summary: &653 title: Sub-issues Summary type: object properties: @@ -10695,7 +10852,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &650 + issue_dependencies_summary: &654 title: Issue Dependencies Summary type: object properties: @@ -10714,7 +10871,7 @@ paths: - total_blocking issue_field_values: type: array - items: &651 + items: &655 title: Issue Field Value description: A value assigned to an issue field type: object @@ -10774,7 +10931,7 @@ paths: - node_id - data_type - value - required: &527 + required: &531 - assignee - closed_at - comments @@ -10795,7 +10952,7 @@ paths: - user - created_at - updated_at - comment: &524 + comment: &528 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -10843,7 +11000,7 @@ paths: issue_url: type: string format: uri - author_association: *69 + author_association: *73 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -10853,9 +11010,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 - reactions: *70 + properties: *71 + required: *72 + reactions: *74 required: - id - node_id @@ -10941,7 +11098,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': &104 + '503': &110 description: Service unavailable content: application/json: @@ -11034,7 +11191,7 @@ paths: _links: type: object properties: - timeline: &71 + timeline: &75 title: Link With Type description: Hypermedia Link with Type type: object @@ -11046,17 +11203,17 @@ paths: required: - href - type - user: *71 - security_advisories: *71 - current_user: *71 - current_user_public: *71 - current_user_actor: *71 - current_user_organization: *71 + user: *75 + security_advisories: *75 + current_user: *75 + current_user_public: *75 + current_user_actor: *75 + current_user_organization: *75 current_user_organizations: type: array - items: *71 - repository_discussions: *71 - repository_discussions_category: *71 + items: *75 + repository_discussions: *75 + repository_discussions_category: *75 required: - timeline - user @@ -11118,7 +11275,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *72 + - *76 - *17 - *19 responses: @@ -11128,7 +11285,7 @@ paths: application/json: schema: type: array - items: &73 + items: &77 title: Base Gist description: Base Gist type: object @@ -11227,7 +11384,7 @@ paths: - created_at - updated_at examples: - default: &74 + default: &78 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -11272,7 +11429,7 @@ paths: site_admin: false truncated: false headers: - Link: *54 + Link: *58 '304': *37 '403': *29 x-github: @@ -11348,7 +11505,7 @@ paths: description: Response content: application/json: - schema: &75 + schema: &79 title: Gist Simple description: Gist Simple type: object @@ -11365,7 +11522,7 @@ paths: url: type: string format: uri - user: &663 + user: &665 title: Public User description: Public User type: object @@ -11727,7 +11884,7 @@ paths: truncated: type: boolean examples: - default: &76 + default: &80 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -11831,7 +11988,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *72 + - *76 - *17 - *19 responses: @@ -11841,11 +11998,11 @@ paths: application/json: schema: type: array - items: *73 + items: *77 examples: - default: *74 + default: *78 headers: - Link: *54 + Link: *58 '422': *15 '304': *37 '403': *29 @@ -11865,7 +12022,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *72 + - *76 - *17 - *19 responses: @@ -11875,11 +12032,11 @@ paths: application/json: schema: type: array - items: *73 + items: *77 examples: - default: *74 + default: *78 headers: - Link: *54 + Link: *58 '401': *25 '304': *37 '403': *29 @@ -11905,7 +12062,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &77 + - &81 name: gist_id description: The unique identifier of the gist. in: path @@ -11917,10 +12074,10 @@ paths: description: Response content: application/json: - schema: *75 + schema: *79 examples: - default: *76 - '403': &80 + default: *80 + '403': &84 description: Forbidden Gist content: application/json: @@ -11968,7 +12125,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *77 + - *81 requestBody: required: true content: @@ -12028,9 +12185,9 @@ paths: description: Response content: application/json: - schema: *75 + schema: *79 examples: - updateGist: *76 + updateGist: *80 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -12188,7 +12345,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *77 + - *81 responses: '204': description: Response @@ -12217,7 +12374,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *77 + - *81 - *17 - *19 responses: @@ -12227,7 +12384,7 @@ paths: application/json: schema: type: array - items: &78 + items: &82 title: Gist Comment description: A comment made to a gist. type: object @@ -12262,7 +12419,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *69 + author_association: *73 required: - url - id @@ -12302,7 +12459,7 @@ paths: updated_at: '2011-04-18T23:23:56Z' author_association: COLLABORATOR headers: - Link: *54 + Link: *58 '304': *37 '404': *6 '403': *29 @@ -12327,7 +12484,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *77 + - *81 requestBody: required: true content: @@ -12352,9 +12509,9 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: &79 + default: &83 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -12412,8 +12569,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *77 - - &81 + - *81 + - &85 name: comment_id description: The unique identifier of the comment. in: path @@ -12426,12 +12583,12 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *79 + default: *83 '304': *37 '404': *6 - '403': *80 + '403': *84 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -12453,8 +12610,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *77 - *81 + - *85 requestBody: required: true content: @@ -12479,9 +12636,9 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *79 + default: *83 '404': *6 x-github: githubCloudOnly: false @@ -12498,8 +12655,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *77 - *81 + - *85 responses: '204': description: Response @@ -12522,7 +12679,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *77 + - *81 - *17 - *19 responses: @@ -12623,7 +12780,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *77 + - *81 - *17 - *19 responses: @@ -12633,7 +12790,7 @@ paths: application/json: schema: type: array - items: *75 + items: *79 examples: default: value: @@ -12679,7 +12836,7 @@ paths: type: User site_admin: false headers: - Link: *54 + Link: *58 '404': *6 '304': *37 '403': *29 @@ -12698,13 +12855,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *77 + - *81 responses: '201': description: Response content: application/json: - schema: *73 + schema: *77 examples: default: value: @@ -12775,7 +12932,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *77 + - *81 responses: '204': description: Response if gist is starred @@ -12805,7 +12962,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *77 + - *81 responses: '204': description: Response @@ -12827,7 +12984,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *77 + - *81 responses: '204': description: Response @@ -12856,7 +13013,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *77 + - *81 - name: sha in: path required: true @@ -12867,9 +13024,9 @@ paths: description: Response content: application/json: - schema: *75 + schema: *79 examples: - default: *76 + default: *80 '422': *15 '404': *6 '403': *29 @@ -13028,7 +13185,7 @@ paths: type: integer repositories: type: array - items: *66 + items: *70 repository_selection: type: string example: selected @@ -13151,7 +13308,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *54 + Link: *58 '403': *29 '304': *37 '401': *25 @@ -13235,7 +13392,7 @@ paths: - closed - all default: open - - &222 + - &228 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -13253,8 +13410,8 @@ paths: - updated - comments default: created - - *48 - - *72 + - *52 + - *76 - name: collab in: query required: false @@ -13284,9 +13441,9 @@ paths: application/json: schema: type: array - items: *82 + items: *86 examples: - default: &223 + default: &229 value: - id: 1 node_id: MDU6SXNzdWUx @@ -13530,7 +13687,7 @@ paths: watchers: 1 author_association: COLLABORATOR headers: - Link: *54 + Link: *58 '422': *15 '304': *37 '404': *6 @@ -13569,8 +13726,8 @@ paths: title: License Simple description: License Simple type: object - properties: *83 - required: *84 + properties: *87 + required: *88 examples: default: value: @@ -13855,7 +14012,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &85 + X-CommonMarker-Version: &89 example: 0.17.4 schema: type: string @@ -13910,7 +14067,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *85 + X-CommonMarker-Version: *89 content: text/html: schema: @@ -13939,7 +14096,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &88 + - &92 name: account_id description: account_id parameter in: path @@ -13951,7 +14108,7 @@ paths: description: Response content: application/json: - schema: &87 + schema: &91 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -13981,7 +14138,7 @@ paths: nullable: true id: type: integer - plan: &86 + plan: &90 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -14070,7 +14227,7 @@ paths: nullable: true updated_at: type: string - plan: *86 + plan: *90 required: - url - id @@ -14078,7 +14235,7 @@ paths: - login - marketplace_purchase examples: - default: &89 + default: &93 value: url: https://api.github.com/orgs/github type: Organization @@ -14163,9 +14320,9 @@ paths: application/json: schema: type: array - items: *86 + items: *90 examples: - default: &90 + default: &94 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -14183,7 +14340,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *54 + Link: *58 '404': *6 '401': *25 x-github: @@ -14205,14 +14362,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &91 + - &95 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &92 + - &96 name: sort description: The property to sort the results by. in: query @@ -14242,9 +14399,9 @@ paths: application/json: schema: type: array - items: *87 + items: *91 examples: - default: &93 + default: &97 value: - url: https://api.github.com/orgs/github type: Organization @@ -14295,7 +14452,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *54 + Link: *58 '404': *6 '422': *15 '401': *25 @@ -14318,15 +14475,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *88 + - *92 responses: '200': description: Response content: application/json: - schema: *87 + schema: *91 examples: - default: *89 + default: *93 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -14358,11 +14515,11 @@ paths: application/json: schema: type: array - items: *86 + items: *90 examples: - default: *90 + default: *94 headers: - Link: *54 + Link: *58 '401': *25 x-github: githubCloudOnly: false @@ -14383,8 +14540,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *91 - - *92 + - *95 + - *96 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -14404,11 +14561,11 @@ paths: application/json: schema: type: array - items: *87 + items: *91 examples: - default: *93 + default: *97 headers: - Link: *54 + Link: *58 '401': *25 x-github: githubCloudOnly: false @@ -14670,14 +14827,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &327 + - &332 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &328 + - &333 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -14694,7 +14851,7 @@ paths: application/json: schema: type: array - items: *94 + items: *98 examples: default: value: @@ -14739,7 +14896,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &334 + '301': &336 description: Moved permanently content: application/json: @@ -14761,7 +14918,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &556 + - &560 name: all description: If `true`, show notifications marked as read. in: query @@ -14769,7 +14926,7 @@ paths: schema: type: boolean default: false - - &557 + - &561 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -14778,8 +14935,8 @@ paths: schema: type: boolean default: false - - *72 - - &558 + - *76 + - &562 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: @@ -14804,18 +14961,18 @@ paths: application/json: schema: type: array - items: &95 + items: &99 title: Thread description: Thread type: object properties: id: type: string - repository: &143 + repository: &149 title: Minimal Repository description: Minimal Repository type: object - properties: &192 + properties: &198 id: type: integer format: int64 @@ -15091,7 +15248,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &272 + security_and_analysis: &278 nullable: true type: object properties: @@ -15165,7 +15322,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &193 + required: &199 - archive_url - assignees_url - blobs_url @@ -15253,7 +15410,7 @@ paths: - url - subscription_url examples: - default: &559 + default: &563 value: - id: '1' repository: @@ -15335,7 +15492,7 @@ paths: url: https://api.github.com/notifications/threads/1 subscription_url: https://api.github.com/notifications/threads/1/subscription headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -15419,7 +15576,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &96 + - &100 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 @@ -15433,7 +15590,7 @@ paths: description: Response content: application/json: - schema: *95 + schema: *99 examples: default: value: @@ -15535,7 +15692,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *96 + - *100 responses: '205': description: Reset Content @@ -15557,7 +15714,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *96 + - *100 responses: '204': description: No content @@ -15580,13 +15737,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *96 + - *100 responses: '200': description: Response content: application/json: - schema: &97 + schema: &101 title: Thread Subscription description: Thread Subscription type: object @@ -15623,7 +15780,7 @@ paths: - url - subscribed examples: - default: &98 + default: &102 value: subscribed: true ignored: false @@ -15654,7 +15811,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *96 + - *100 requestBody: required: false content: @@ -15675,9 +15832,9 @@ paths: description: Response content: application/json: - schema: *97 + schema: *101 examples: - default: *98 + default: *102 '304': *37 '403': *29 '401': *25 @@ -15700,7 +15857,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *96 + - *100 responses: '204': description: Response @@ -15795,9 +15952,9 @@ paths: application/json: schema: type: array - items: *61 + items: *65 examples: - default: *99 + default: *103 headers: Link: example: ; rel="next" @@ -15809,6 +15966,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: + - *67 + responses: + '200': + description: Response + content: + application/json: + schema: &104 + 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 + example: 14 + examples: + default: *42 + '403': *29 + '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: + - *67 + requestBody: + required: true + content: + application/json: + schema: *104 + examples: + selected_actions: *42 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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: + - *67 + responses: + '200': + description: Response + content: + application/json: + schema: &105 + 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 + example: 10 + examples: + default: *44 + '403': *29 + '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: + - *67 + requestBody: + required: true + content: + application/json: + schema: *105 + examples: + selected_actions: *44 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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 @@ -15824,7 +16127,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: - - *63 + - *67 - name: page in: query description: The page number of results to fetch. @@ -15868,8 +16171,8 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: *100 - required: *101 + properties: *106 + required: *107 nullable: true additionalProperties: false examples: @@ -15975,7 +16278,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *63 + - *67 requestBody: required: true content: @@ -16041,7 +16344,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *63 + - *67 requestBody: required: true content: @@ -16093,7 +16396,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: - - *63 + - *67 responses: '200': description: Response @@ -16101,7 +16404,7 @@ paths: application/json: schema: type: array - items: &102 + items: &108 title: Custom Property Value description: Custom property name and associated value type: object @@ -16121,7 +16424,7 @@ paths: - property_name - value examples: - default: &565 + default: &569 value: - property_name: environment value: production @@ -16155,7 +16458,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: - - *63 + - *67 requestBody: required: true content: @@ -16167,11 +16470,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the organization. - items: *102 + items: *108 required: - properties examples: - default: &566 + default: &570 value: properties: - property_name: environment @@ -16207,7 +16510,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#get-all-budgets-for-an-organization parameters: - - *63 + - *67 + - *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 @@ -16283,6 +16604,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: @@ -16324,7 +16649,7 @@ paths: alert_recipients: [] '404': *6 '403': *29 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16345,8 +16670,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#get-a-budget-by-id-for-an-organization parameters: - - *63 - - &105 + - *67 + - &111 name: budget_id description: The ID corresponding to the budget. in: path @@ -16439,8 +16764,8 @@ paths: '400': *14 '404': *6 '403': *29 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16460,8 +16785,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#update-a-budget-for-an-organization parameters: - - *63 - - *105 + - *67 + - *111 requestBody: required: true content: @@ -16585,7 +16910,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': *25 '403': *29 @@ -16634,8 +16971,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization parameters: - - *63 - - *105 + - *67 + - *111 responses: '200': description: Response when deleting a budget @@ -16661,8 +16998,8 @@ paths: '400': *14 '404': *6 '403': *29 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16682,8 +17019,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-an-organization parameters: - - *63 - - &106 + - *67 + - &112 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, @@ -16692,7 +17029,7 @@ paths: required: false schema: type: integer - - &108 + - &114 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 @@ -16701,7 +17038,7 @@ paths: required: false schema: type: integer - - &107 + - &113 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 @@ -16716,14 +17053,14 @@ paths: required: false schema: type: string - - &702 + - &713 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &109 + - &115 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -16839,8 +17176,8 @@ paths: '400': *14 '403': *29 '404': *6 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16860,9 +17197,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-an-organization parameters: - - *63 - - *106 - - &703 + - *67 + - *112 + - &714 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 @@ -16871,7 +17208,7 @@ paths: required: false schema: type: integer - - *107 + - *113 responses: '200': description: Billing usage report response for an organization @@ -16946,8 +17283,8 @@ paths: repositoryName: github/example '400': *14 '403': *29 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16970,19 +17307,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-an-organization parameters: - - *63 - - *106 - - *108 - - *107 - - &704 + - *67 + - *112 + - *114 + - *113 + - &715 name: repository description: The repository name to query for usage in the format owner/repository. in: query required: false schema: type: string - - *109 - - &705 + - *115 + - &716 name: sku description: The SKU to query for usage. in: query @@ -17092,8 +17429,8 @@ paths: netAmount: 8.0 '400': *14 '403': *29 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17119,13 +17456,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: &110 + schema: &116 title: Organization Full description: Organization Full type: object @@ -17444,7 +17781,7 @@ paths: - updated_at - archived_at examples: - default-response: &111 + default-response: &117 value: login: github id: 1 @@ -17544,7 +17881,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *63 + - *67 requestBody: required: false content: @@ -17760,18 +18097,18 @@ paths: description: Response content: application/json: - schema: *110 + schema: *116 examples: - default: *111 + default: *117 '422': description: Validation failed content: application/json: schema: oneOf: - - *112 - - *113 - '409': *47 + - *118 + - *119 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17794,7 +18131,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *63 + - *67 responses: '202': *39 '404': *6 @@ -17819,7 +18156,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response @@ -17845,7 +18182,7 @@ paths: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17866,7 +18203,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: - - *63 + - *67 - *17 - *19 responses: @@ -17884,7 +18221,7 @@ paths: type: integer repository_cache_usages: type: array - items: &339 + items: &343 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -17919,7 +18256,7 @@ paths: active_caches_size_in_bytes: 1022142 active_caches_count: 2 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17939,7 +18276,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *63 + - *67 - *17 - *19 responses: @@ -17957,7 +18294,7 @@ paths: type: integer runners: type: array - items: &114 + items: &120 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -18011,7 +18348,7 @@ paths: - display_name - source nullable: true - machine_size_details: &122 + machine_size_details: &128 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -18107,7 +18444,7 @@ paths: - public_ip_enabled - platform examples: - default: &142 + default: &148 value: total_count: 2 runners: @@ -18149,7 +18486,7 @@ paths: public_ips: [] last_active_on: '2023-04-26T15:23:37Z' headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18167,7 +18504,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - - *63 + - *67 requestBody: required: true content: @@ -18244,9 +18581,9 @@ paths: description: Response content: application/json: - schema: *114 + schema: *120 examples: - default: &123 + default: &129 value: id: 5 name: My hosted ubuntu runner @@ -18287,7 +18624,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response @@ -18303,7 +18640,7 @@ paths: type: integer images: type: array - items: &115 + items: &121 title: GitHub-hosted runner custom image details description: Provides details of a custom runner image type: object @@ -18354,7 +18691,7 @@ paths: - latest_version - state examples: - default: &117 + default: &123 value: total_count: 2 image_versions: @@ -18385,8 +18722,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: - - *63 - - &116 + - *67 + - &122 name: image_definition_id description: Image definition ID of custom image in: path @@ -18398,7 +18735,7 @@ paths: description: Response content: application/json: - schema: *115 + schema: *121 examples: default: value: @@ -18428,8 +18765,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization parameters: - - *63 - - *116 + - *67 + - *122 responses: '204': description: Response @@ -18452,8 +18789,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: - - *116 - - *63 + - *122 + - *67 responses: '200': description: Response @@ -18469,7 +18806,7 @@ paths: type: integer image_versions: type: array - items: &118 + items: &124 title: GitHub-hosted runner custom image version details. description: Provides details of a hosted runner custom image version @@ -18502,7 +18839,7 @@ paths: - created_on - state_details examples: - default: *117 + default: *123 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18522,9 +18859,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: - - *63 - - *116 - - &119 + - *67 + - *122 + - &125 name: version description: Version of a custom image in: path @@ -18537,7 +18874,7 @@ paths: description: Response content: application/json: - schema: *118 + schema: *124 examples: default: value: @@ -18563,9 +18900,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: - - *63 - - *116 - - *119 + - *67 + - *122 + - *125 responses: '204': description: Response @@ -18586,7 +18923,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: - - *63 + - *67 responses: '200': description: Response @@ -18602,7 +18939,7 @@ paths: type: integer images: type: array - items: &120 + items: &126 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -18638,7 +18975,7 @@ paths: - display_name - source examples: - default: &121 + default: &127 value: id: ubuntu-20.04 platform: linux-x64 @@ -18662,7 +18999,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: - - *63 + - *67 responses: '200': description: Response @@ -18678,9 +19015,9 @@ paths: type: integer images: type: array - items: *120 + items: *126 examples: - default: *121 + default: *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18697,7 +19034,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: - - *63 + - *67 responses: '200': description: Response @@ -18750,7 +19087,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: - - *63 + - *67 responses: '200': description: Response @@ -18766,7 +19103,7 @@ paths: type: integer machine_specs: type: array - items: *122 + items: *128 examples: default: value: @@ -18791,7 +19128,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: - - *63 + - *67 responses: '200': description: Response @@ -18835,8 +19172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - - *63 - - &124 + - *67 + - &130 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -18848,11 +19185,11 @@ paths: description: Response content: application/json: - schema: *114 + schema: *120 examples: - default: *123 + default: *129 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18870,8 +19207,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *63 - - *124 + - *67 + - *130 requestBody: required: true content: @@ -18914,9 +19251,9 @@ paths: description: Response content: application/json: - schema: *114 + schema: *120 examples: - default: *123 + default: *129 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -18932,16 +19269,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *63 - - *124 + - *67 + - *130 responses: '202': description: Response content: application/json: - schema: *114 + schema: *120 examples: - default: *123 + default: *129 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -18961,13 +19298,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: - - *63 + - *67 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &125 + schema: &131 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -18981,7 +19318,7 @@ paths: required: - include_claim_keys examples: - default: &126 + default: &132 value: include_claim_keys: - repo @@ -19003,20 +19340,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: - - *63 + - *67 requestBody: required: true content: application/json: - schema: *125 + schema: *131 examples: - default: *126 + default: *132 responses: '201': description: Empty response content: application/json: - schema: &152 + schema: &158 title: Empty Object description: An object without any properties. type: object @@ -19046,7 +19383,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response @@ -19055,7 +19392,7 @@ paths: schema: type: object properties: - enabled_repositories: &127 + enabled_repositories: &133 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -19068,7 +19405,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: &128 + allowed_actions: &134 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -19076,12 +19413,12 @@ paths: - all - local_only - selected - selected_actions_url: &345 + selected_actions_url: &349 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: &129 + sha_pinning_required: &135 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -19112,7 +19449,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *63 + - *67 responses: '204': description: Response @@ -19123,9 +19460,9 @@ paths: schema: type: object properties: - enabled_repositories: *127 - allowed_actions: *128 - sha_pinning_required: *129 + enabled_repositories: *133 + allowed_actions: *134 + sha_pinning_required: *135 required: - enabled_repositories examples: @@ -19153,13 +19490,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: &349 + schema: &353 type: object properties: days: @@ -19196,12 +19533,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization parameters: - - *63 + - *67 requestBody: required: true content: application/json: - schema: &350 + schema: &354 type: object properties: days: @@ -19218,7 +19555,7 @@ paths: description: No content '403': *29 '404': *6 - '409': *47 + '409': *51 '422': *15 x-github: enabledForGitHubApps: true @@ -19238,13 +19575,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: &130 + schema: &136 type: object properties: approval_policy: @@ -19258,7 +19595,7 @@ paths: required: - approval_policy examples: - default: &351 + default: &355 value: approval_policy: first_time_contributors '404': *6 @@ -19279,7 +19616,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *63 + - *67 responses: '204': description: Response @@ -19289,7 +19626,7 @@ paths: required: true content: application/json: - schema: *130 + schema: *136 examples: default: summary: Set approval policy to first time contributors @@ -19311,13 +19648,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: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: &352 + schema: &356 type: object required: - run_workflows_from_fork_pull_requests @@ -19343,7 +19680,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &131 + default: &137 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -19366,12 +19703,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: - - *63 + - *67 requestBody: required: true content: application/json: - schema: &353 + schema: &357 type: object required: - run_workflows_from_fork_pull_requests @@ -19394,7 +19731,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *131 + default: *137 responses: '204': description: Empty response for successful settings update @@ -19424,7 +19761,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: - - *63 + - *67 - *17 - *19 responses: @@ -19442,9 +19779,9 @@ paths: type: number repositories: type: array - items: *66 + items: *70 examples: - default: &135 + default: &141 value: total_count: 1 repositories: @@ -19584,7 +19921,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: - - *63 + - *67 responses: '204': description: Response @@ -19628,8 +19965,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: - - *63 - - &132 + - *67 + - &138 name: repository_id description: The unique identifier of the repository. in: path @@ -19657,8 +19994,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: - - *63 - - *132 + - *67 + - *138 responses: '204': description: Response @@ -19681,13 +20018,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: &133 + schema: &139 type: object properties: github_owned_allowed: @@ -19709,7 +20046,7 @@ paths: items: type: string examples: - default: &134 + default: &140 value: github_owned_allowed: true verified_allowed: false @@ -19734,7 +20071,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *63 + - *67 responses: '204': description: Response @@ -19742,9 +20079,9 @@ paths: required: false content: application/json: - schema: *133 + schema: *139 examples: - selected_actions: *134 + selected_actions: *140 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -19764,7 +20101,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response @@ -19812,7 +20149,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization parameters: - - *63 + - *67 requestBody: required: true content: @@ -19839,7 +20176,7 @@ paths: description: No content '403': *29 '404': *6 - '409': *47 + '409': *51 '422': *15 x-github: enabledForGitHubApps: true @@ -19859,7 +20196,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: - - *63 + - *67 - *17 - *19 responses: @@ -19874,9 +20211,9 @@ paths: type: integer repositories: type: array - items: *66 + items: *70 examples: - default: *135 + default: *141 '403': *29 '404': *6 x-github: @@ -19896,7 +20233,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: - - *63 + - *67 requestBody: required: true content: @@ -19944,14 +20281,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: - - *63 - - *132 + - *67 + - *138 responses: '204': description: No content '403': *29 '404': *6 - '409': *47 + '409': *51 '422': *15 x-github: enabledForGitHubApps: true @@ -19971,14 +20308,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: - - *63 - - *132 + - *67 + - *138 responses: '204': description: No content '403': *29 '404': *6 - '409': *47 + '409': *51 '422': *15 x-github: enabledForGitHubApps: true @@ -20000,23 +20337,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: &354 + schema: &358 type: object properties: - default_workflow_permissions: &136 + default_workflow_permissions: &142 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &137 + can_approve_pull_request_reviews: &143 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -20024,7 +20361,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &138 + default: &144 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -20049,7 +20386,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *63 + - *67 responses: '204': description: Success response @@ -20057,13 +20394,13 @@ paths: required: false content: application/json: - schema: &355 + schema: &359 type: object properties: - default_workflow_permissions: *136 - can_approve_pull_request_reviews: *137 + default_workflow_permissions: *142 + can_approve_pull_request_reviews: *143 examples: - default: *138 + default: *144 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20083,7 +20420,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: - - *63 + - *67 - *17 - *19 - name: visible_to_repository @@ -20108,7 +20445,7 @@ paths: type: number runner_groups: type: array - items: &139 + items: &145 type: object properties: id: @@ -20224,7 +20561,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: - - *63 + - *67 requestBody: required: true content: @@ -20296,9 +20633,9 @@ paths: description: Response content: application/json: - schema: *139 + schema: *145 examples: - default: &141 + default: &147 value: id: 2 name: octo-runner-group @@ -20333,8 +20670,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: - - *63 - - &140 + - *67 + - &146 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -20346,7 +20683,7 @@ paths: description: Response content: application/json: - schema: *139 + schema: *145 examples: default: value: @@ -20382,8 +20719,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: - - *63 - - *140 + - *67 + - *146 requestBody: required: true content: @@ -20437,9 +20774,9 @@ paths: description: Response content: application/json: - schema: *139 + schema: *145 examples: - default: *141 + default: *147 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -20458,8 +20795,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: - - *63 - - *140 + - *67 + - *146 responses: '204': description: Response @@ -20482,8 +20819,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: - - *63 - - *140 + - *67 + - *146 - *17 - *19 responses: @@ -20501,11 +20838,11 @@ paths: type: number runners: type: array - items: *114 + items: *120 examples: - default: *142 + default: *148 headers: - Link: *54 + Link: *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -20525,8 +20862,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: - - *63 - - *140 + - *67 + - *146 - *19 - *17 responses: @@ -20544,9 +20881,9 @@ paths: type: number repositories: type: array - items: *143 + items: *149 examples: - default: &666 + default: &668 value: total_count: 1 repositories: @@ -20798,8 +21135,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: - - *63 - - *140 + - *67 + - *146 requestBody: required: true content: @@ -20843,9 +21180,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: - - *63 - - *140 - - *132 + - *67 + - *146 + - *138 responses: '204': description: Response @@ -20867,9 +21204,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: - - *63 - - *140 - - *132 + - *67 + - *146 + - *138 responses: '204': description: Response @@ -20892,8 +21229,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: - - *63 - - *140 + - *67 + - *146 - *17 - *19 responses: @@ -20911,7 +21248,7 @@ paths: type: number runners: type: array - items: &145 + items: &151 title: Self hosted runners description: A self hosted runner type: object @@ -20940,7 +21277,7 @@ paths: type: boolean labels: type: array - items: &148 + items: &154 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -20970,7 +21307,7 @@ paths: - busy - labels examples: - default: &146 + default: &152 value: total_count: 2 runners: @@ -21010,7 +21347,7 @@ paths: name: no-gpu type: custom headers: - Link: *54 + Link: *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21029,8 +21366,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: - - *63 - - *140 + - *67 + - *146 requestBody: required: true content: @@ -21074,9 +21411,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: - - *63 - - *140 - - &144 + - *67 + - *146 + - &150 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -21104,9 +21441,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: - - *63 - - *140 - - *144 + - *67 + - *146 + - *150 responses: '204': description: Response @@ -21136,7 +21473,7 @@ paths: in: query schema: type: string - - *63 + - *67 - *17 - *19 responses: @@ -21154,11 +21491,11 @@ paths: type: integer runners: type: array - items: *145 + items: *151 examples: - default: *146 + default: *152 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21180,7 +21517,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response @@ -21188,7 +21525,7 @@ paths: application/json: schema: type: array - items: &356 + items: &360 title: Runner Application description: Runner Application type: object @@ -21213,7 +21550,7 @@ paths: - download_url - filename examples: - default: &357 + default: &361 value: - os: osx architecture: x64 @@ -21256,7 +21593,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: - - *63 + - *67 requestBody: required: true content: @@ -21299,7 +21636,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &358 + '201': &362 description: Response content: application/json: @@ -21309,7 +21646,7 @@ paths: - runner - encoded_jit_config properties: - runner: *145 + runner: *151 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -21338,7 +21675,7 @@ paths: encoded_jit_config: abc123 '404': *6 '422': *7 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21366,13 +21703,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *63 + - *67 responses: '201': description: Response content: application/json: - schema: &147 + schema: &153 title: Authentication Token description: Authentication Token type: object @@ -21394,7 +21731,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *66 + items: *70 single_file: type: string example: config.yaml @@ -21410,7 +21747,7 @@ paths: - token - expires_at examples: - default: &359 + default: &363 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -21441,15 +21778,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *63 + - *67 responses: '201': description: Response content: application/json: - schema: *147 + schema: *153 examples: - default: &360 + default: &364 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -21474,16 +21811,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: - - *63 - - *144 + - *67 + - *150 responses: '200': description: Response content: application/json: - schema: *145 + schema: *151 examples: - default: &361 + default: &365 value: id: 23 name: MBP @@ -21524,8 +21861,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: - - *63 - - *144 + - *67 + - *150 responses: '204': description: Response @@ -21551,10 +21888,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: - - *63 - - *144 + - *67 + - *150 responses: - '200': &149 + '200': &155 description: Response content: application/json: @@ -21568,7 +21905,7 @@ paths: type: integer labels: type: array - items: *148 + items: *154 examples: default: value: @@ -21607,8 +21944,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: - - *63 - - *144 + - *67 + - *150 requestBody: required: true content: @@ -21632,7 +21969,7 @@ paths: - gpu - accelerated responses: - '200': *149 + '200': *155 '404': *6 '422': *7 x-github: @@ -21656,8 +21993,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: - - *63 - - *144 + - *67 + - *150 requestBody: required: true content: @@ -21682,7 +22019,7 @@ paths: - gpu - accelerated responses: - '200': *149 + '200': *155 '404': *6 '422': *7 x-github: @@ -21706,10 +22043,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: - - *63 - - *144 + - *67 + - *150 responses: - '200': &362 + '200': &366 description: Response content: application/json: @@ -21723,7 +22060,7 @@ paths: type: integer labels: type: array - items: *148 + items: *154 examples: default: value: @@ -21764,9 +22101,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: - - *63 - - *144 - - &363 + - *67 + - *150 + - &367 name: name description: The name of a self-hosted runner's custom label. in: path @@ -21774,7 +22111,7 @@ paths: schema: type: string responses: - '200': *149 + '200': *155 '404': *6 '422': *7 x-github: @@ -21799,7 +22136,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *63 + - *67 - *17 - *19 responses: @@ -21817,7 +22154,7 @@ paths: type: integer secrets: type: array - items: &150 + items: &156 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -21867,7 +22204,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21890,13 +22227,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: &375 + schema: &379 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -21925,7 +22262,7 @@ paths: - key_id - key examples: - default: &376 + default: &380 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -21950,8 +22287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *63 - - &151 + - *67 + - &157 name: secret_name description: The name of the secret. in: path @@ -21963,7 +22300,7 @@ paths: description: Response content: application/json: - schema: *150 + schema: *156 examples: default: value: @@ -21993,8 +22330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 requestBody: required: true content: @@ -22051,7 +22388,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -22077,8 +22414,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 responses: '204': description: Response @@ -22104,8 +22441,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 - *19 - *17 responses: @@ -22123,9 +22460,9 @@ paths: type: integer repositories: type: array - items: *143 + items: *149 examples: - default: &155 + default: &161 value: total_count: 1 repositories: @@ -22217,8 +22554,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 requestBody: required: true content: @@ -22270,8 +22607,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 - name: repository_id in: path required: true @@ -22304,8 +22641,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 - name: repository_id in: path required: true @@ -22337,8 +22674,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *63 - - &344 + - *67 + - &348 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)." @@ -22362,7 +22699,7 @@ paths: type: integer variables: type: array - items: &153 + items: &159 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -22426,7 +22763,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22447,7 +22784,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *63 + - *67 requestBody: required: true content: @@ -22495,7 +22832,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -22520,8 +22857,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *63 - - &154 + - *67 + - &160 name: name description: The name of the variable. in: path @@ -22533,7 +22870,7 @@ paths: description: Response content: application/json: - schema: *153 + schema: *159 examples: default: value: @@ -22563,8 +22900,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *63 - - *154 + - *67 + - *160 requestBody: required: true content: @@ -22626,8 +22963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *63 - - *154 + - *67 + - *160 responses: '204': description: Response @@ -22653,8 +22990,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *63 - - *154 + - *67 + - *160 - *19 - *17 responses: @@ -22672,9 +23009,9 @@ paths: type: integer repositories: type: array - items: *143 + items: *149 examples: - default: *155 + default: *161 '409': description: Response when the visibility of the variable is not set to `selected` @@ -22700,8 +23037,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *63 - - *154 + - *67 + - *160 requestBody: required: true content: @@ -22750,8 +23087,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *63 - - *154 + - *67 + - *160 - name: repository_id in: path required: true @@ -22785,8 +23122,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *63 - - *154 + - *67 + - *160 - name: repository_id in: path required: true @@ -22816,7 +23153,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#create-an-artifact-deployment-record parameters: - - *63 + - *67 requestBody: required: true content: @@ -22923,7 +23260,7 @@ paths: type: integer deployment_records: type: array - items: &156 + items: &162 title: Artifact Deployment Record description: Artifact Metadata Deployment Record type: object @@ -22967,7 +23304,7 @@ paths: with the deployment record. nullable: true examples: - default: &157 + default: &163 value: total_count: 1 deployment_records: @@ -22998,7 +23335,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records parameters: - - *63 + - *67 - name: cluster in: path description: The cluster name. @@ -23113,9 +23450,9 @@ paths: type: integer deployment_records: type: array - items: *156 + items: *162 examples: - default: *157 + default: *163 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23135,7 +23472,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - - *63 + - *67 requestBody: required: true content: @@ -23286,7 +23623,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-deployment-records parameters: - - *63 + - *67 - name: subject_digest description: The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. in: path @@ -23311,9 +23648,9 @@ paths: type: integer deployment_records: type: array - items: *156 + items: *162 examples: - default: *157 + default: *163 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23333,7 +23670,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - - *63 + - *67 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -23416,9 +23753,9 @@ paths: url: https://docs.github.com/rest/orgs/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *40 - - *41 - - *63 + - *45 + - *46 + - *67 requestBody: required: true content: @@ -23442,12 +23779,12 @@ paths: required: - subject_digests examples: - default: &694 + default: &696 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &695 + withPredicateType: &697 value: subject_digests: - sha256:abc123 @@ -23505,7 +23842,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &696 + default: &698 value: attestations_subject_digests: - sha256:abc: @@ -23614,7 +23951,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *63 + - *67 requestBody: required: true content: @@ -23679,7 +24016,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *63 + - *67 - name: subject_digest description: Subject Digest in: path @@ -23712,9 +24049,9 @@ paths: url: https://docs.github.com/rest/orgs/attestations#list-attestation-repositories parameters: - *17 - - *40 - - *41 - - *63 + - *45 + - *46 + - *67 - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. @@ -23762,7 +24099,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id parameters: - - *63 + - *67 - name: attestation_id description: Attestation ID in: path @@ -23798,9 +24135,9 @@ paths: url: https://docs.github.com/rest/orgs/attestations#list-attestations parameters: - *17 - - *40 - - *41 - - *63 + - *45 + - *46 + - *67 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -23854,7 +24191,7 @@ paths: initiator: type: string examples: - default: &389 + default: &393 value: attestations: - bundle: @@ -23961,7 +24298,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *63 + - *67 - *17 - *19 responses: @@ -23973,7 +24310,7 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23992,8 +24329,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: + - *67 - *63 - - *59 responses: '204': description: If the user is blocked @@ -24018,8 +24355,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: + - *67 - *63 - - *59 responses: '204': description: Response @@ -24039,8 +24376,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: + - *67 - *63 - - *59 responses: '204': description: Response @@ -24065,15 +24402,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *63 + - *67 - *19 - *17 - - *48 + - *52 - name: state description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &158 + schema: &164 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -24099,7 +24436,7 @@ paths: application/json: schema: type: array - items: &159 + items: &165 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -24130,7 +24467,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &181 + items: &187 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -24205,7 +24542,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &234 + properties: &240 id: description: Unique identifier of the team type: integer @@ -24277,7 +24614,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &235 + required: &241 - id - node_id - url @@ -24320,7 +24657,7 @@ paths: type: string format: date-time nullable: true - state: *158 + state: *164 contact_link: description: The contact link of the campaign. type: string @@ -24415,9 +24752,9 @@ paths: closed_at: state: open headers: - Link: *54 + Link: *58 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24441,7 +24778,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *63 + - *67 requestBody: required: true content: @@ -24540,9 +24877,9 @@ paths: description: Response content: application/json: - schema: *159 + schema: *165 examples: - default: &160 + default: &166 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -24591,7 +24928,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24613,7 +24950,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *63 + - *67 - name: campaign_number description: The campaign number. in: path @@ -24625,16 +24962,16 @@ paths: description: Response content: application/json: - schema: *159 + schema: *165 examples: - default: *160 + default: *166 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24655,7 +24992,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign parameters: - - *63 + - *67 - name: campaign_number description: The campaign number. in: path @@ -24704,7 +25041,7 @@ paths: type: string format: uri nullable: true - state: *158 + state: *164 examples: default: value: @@ -24714,9 +25051,9 @@ paths: description: Response content: application/json: - schema: *159 + schema: *165 examples: - default: *160 + default: *166 '400': description: Bad Request content: @@ -24728,7 +25065,7 @@ paths: content: application/json: schema: *3 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24749,7 +25086,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *63 + - *67 - name: campaign_number description: The campaign number. in: path @@ -24760,7 +25097,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24782,18 +25119,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *63 - - &415 + - *67 + - &419 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: &168 + schema: &174 type: string description: The name of the tool used to generate the code scanning analysis. - - &416 + - &420 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 @@ -24801,22 +25138,22 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &169 + schema: &175 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. - - *40 - - *41 + - *45 + - *46 - *19 - *17 - - *48 + - *52 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: &418 + schema: &422 type: string description: State of a code scanning alert. enum: @@ -24839,7 +25176,7 @@ paths: be returned. in: query required: false - schema: &419 + schema: &423 type: string description: Severity of a code scanning alert. enum: @@ -24860,18 +25197,18 @@ paths: items: type: object properties: - number: *161 - created_at: *162 - updated_at: *163 - url: *164 - html_url: *165 - instances_url: &420 + number: *167 + created_at: *168 + updated_at: *169 + url: *170 + html_url: *171 + instances_url: &424 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &170 + state: &176 type: string description: State of a code scanning alert. nullable: true @@ -24879,7 +25216,7 @@ paths: - open - dismissed - fixed - fixed_at: *166 + fixed_at: *172 dismissed_by: title: Simple User description: A GitHub user. @@ -24887,8 +25224,8 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *167 - dismissed_reason: &421 + dismissed_at: *173 + dismissed_reason: &425 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -24897,13 +25234,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &422 + dismissed_comment: &426 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &423 + rule: &427 type: object properties: id: @@ -24956,25 +25293,25 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &424 + tool: &428 type: object properties: - name: *168 + name: *174 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *169 - most_recent_instance: &425 + guid: *175 + most_recent_instance: &429 type: object properties: - ref: &417 + ref: &421 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &435 + analysis_key: &439 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -24985,13 +25322,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &436 + category: &440 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: *170 + state: *176 commit_sha: type: string message: @@ -25030,7 +25367,7 @@ paths: - generated - test - library - repository: *53 + repository: *57 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -25285,9 +25622,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: *54 + Link: *58 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25309,7 +25646,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *63 + - *67 - name: target_type in: query description: The target type of the code security configuration @@ -25328,8 +25665,8 @@ paths: schema: type: integer default: 30 - - *40 - - *41 + - *45 + - *46 responses: '200': description: Response @@ -25337,7 +25674,7 @@ paths: application/json: schema: type: array - items: *43 + items: *47 examples: default: value: @@ -25420,7 +25757,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *63 + - *67 requestBody: required: true content: @@ -25498,7 +25835,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *171 + code_scanning_options: *177 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -25507,7 +25844,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: *46 + code_scanning_default_setup_options: *50 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -25639,9 +25976,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *43 + schema: *47 examples: - default: *172 + default: *178 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25663,15 +26000,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: *173 + schema: *179 examples: - default: *174 + default: *180 '304': *37 '403': *29 '404': *6 @@ -25697,7 +26034,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *63 + - *67 requestBody: required: true content: @@ -25723,11 +26060,11 @@ paths: - 32 - 91 responses: - '204': *175 + '204': *181 '400': *14 '403': *29 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25749,16 +26086,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *63 - - *45 + - *67 + - *49 responses: '200': description: Response content: application/json: - schema: *43 + schema: *47 examples: - default: *172 + default: *178 '304': *37 '403': *29 '404': *6 @@ -25782,8 +26119,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *63 - - *45 + - *67 + - *49 requestBody: required: true content: @@ -25862,7 +26199,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *46 + code_scanning_default_setup_options: *50 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -25980,7 +26317,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *43 + schema: *47 examples: default: value: @@ -26039,14 +26376,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *63 - - *45 + - *67 + - *49 responses: - '204': *175 + '204': *181 '400': *14 '403': *29 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26070,8 +26407,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *63 - - *45 + - *67 + - *49 requestBody: required: true content: @@ -26134,8 +26471,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: - - *63 - - *45 + - *67 + - *49 requestBody: required: true content: @@ -26175,12 +26512,12 @@ paths: - none - private_and_internal - public - configuration: *43 + configuration: *47 examples: default: value: default_for_new_repos: all - configuration: *172 + configuration: *178 '403': *29 '404': *6 x-github: @@ -26204,8 +26541,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *63 - - *45 + - *67 + - *49 - 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)." @@ -26214,8 +26551,8 @@ paths: schema: type: integer default: 30 - - *40 - - *41 + - *45 + - *46 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -26233,13 +26570,13 @@ paths: application/json: schema: type: array - items: *176 + items: *182 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *177 + repository: *183 '403': *29 '404': *6 x-github: @@ -26263,7 +26600,7 @@ paths: parameters: - *17 - *19 - - *63 + - *67 responses: '200': description: Response @@ -26279,7 +26616,7 @@ paths: type: integer codespaces: type: array - items: &224 + items: &230 type: object title: Codespace description: A codespace. @@ -26304,12 +26641,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *143 + repository: *149 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &448 + properties: &452 name: type: string description: The name of the machine. @@ -26351,7 +26688,7 @@ paths: - ready - in_progress nullable: true - required: &449 + required: &453 - name - display_name - operating_system @@ -26556,7 +26893,7 @@ paths: - pulls_url - recent_folders examples: - default: &225 + default: &231 value: total_count: 3 codespaces: @@ -26966,7 +27303,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *37 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -26988,7 +27325,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *63 + - *67 deprecated: true requestBody: required: true @@ -27032,7 +27369,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27055,7 +27392,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *63 + - *67 deprecated: true requestBody: required: true @@ -27087,7 +27424,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27110,7 +27447,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *63 + - *67 requestBody: required: true content: @@ -27141,7 +27478,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27162,7 +27499,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *63 + - *67 - *17 - *19 responses: @@ -27180,7 +27517,7 @@ paths: type: integer secrets: type: array - items: &178 + items: &184 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -27219,7 +27556,7 @@ paths: - updated_at - visibility examples: - default: &450 + default: &454 value: total_count: 2 secrets: @@ -27232,7 +27569,7 @@ paths: updated_at: '2020-01-11T11:59:22Z' visibility: all headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27251,13 +27588,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: &451 + schema: &455 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -27286,7 +27623,7 @@ paths: - key_id - key examples: - default: &452 + default: &456 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -27309,23 +27646,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 responses: '200': description: Response content: application/json: - schema: *178 + schema: *184 examples: - default: &454 + default: &458 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27345,8 +27682,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 requestBody: required: true content: @@ -27401,7 +27738,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -27427,8 +27764,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 responses: '204': description: Response @@ -27453,8 +27790,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 - *19 - *17 responses: @@ -27472,9 +27809,9 @@ paths: type: integer repositories: type: array - items: *143 + items: *149 examples: - default: *155 + default: *161 '404': *6 x-github: githubCloudOnly: false @@ -27496,8 +27833,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 requestBody: required: true content: @@ -27547,8 +27884,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 - name: repository_id in: path required: true @@ -27581,8 +27918,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 - name: repository_id in: path required: true @@ -27621,7 +27958,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: - - *63 + - *67 responses: '200': description: OK @@ -27730,7 +28067,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -27762,7 +28099,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: - - *63 + - *67 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -27785,7 +28122,7 @@ paths: currently being billed. seats: type: array - items: &227 + items: &233 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -27802,15 +28139,15 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *179 - required: *180 + properties: *185 + required: *186 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *181 - - *55 + - *187 + - *59 nullable: true pending_cancellation_date: type: string @@ -27934,8 +28271,8 @@ paths: type: User site_admin: false headers: - Link: *54 - '500': *103 + Link: *58 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -27968,7 +28305,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: - - *63 + - *67 requestBody: content: application/json: @@ -28010,7 +28347,7 @@ paths: default: value: seats_created: 5 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -28046,7 +28383,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: - - *63 + - *67 requestBody: content: application/json: @@ -28088,7 +28425,7 @@ paths: default: value: seats_cancelled: 5 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -28126,7 +28463,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: - - *63 + - *67 requestBody: content: application/json: @@ -28167,7 +28504,7 @@ paths: default: value: seats_created: 5 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -28203,7 +28540,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: - - *63 + - *67 requestBody: content: application/json: @@ -28245,7 +28582,7 @@ paths: default: value: seats_cancelled: 5 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -28284,7 +28621,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *63 + - *67 - 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`). @@ -28316,7 +28653,7 @@ paths: application/json: schema: type: array - items: &309 + items: &316 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -28623,7 +28960,7 @@ paths: - date additionalProperties: true examples: - default: &310 + default: &317 value: - date: '2024-06-24' total_active_users: 24 @@ -28722,10 +29059,10 @@ paths: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - '500': *103 + '500': *109 '403': *29 '404': *6 - '422': &311 + '422': &318 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -28752,12 +29089,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *63 - - *182 - - *183 - - *184 - - *185 - - *186 + - *67 + - *188 + - *189 + - *190 + - *191 + - *192 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -28795,11 +29132,11 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *187 - - *188 - - *48 - - *40 - - *41 + - *193 + - *194 + - *52 + - *45 + - *46 - *17 responses: '200': @@ -28808,9 +29145,9 @@ paths: application/json: schema: type: array - items: *189 + items: *195 examples: - default: *190 + default: *196 '304': *37 '400': *14 '403': *29 @@ -28836,7 +29173,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *63 + - *67 - *17 - *19 responses: @@ -28854,7 +29191,7 @@ paths: type: integer secrets: type: array - items: &191 + items: &197 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -28904,7 +29241,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28925,13 +29262,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: &480 + schema: &484 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -28948,7 +29285,7 @@ paths: - key_id - key examples: - default: &481 + default: &485 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -28971,14 +29308,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 responses: '200': description: Response content: application/json: - schema: *191 + schema: *197 examples: default: value: @@ -29006,8 +29343,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 requestBody: required: true content: @@ -29066,7 +29403,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -29090,8 +29427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 responses: '204': description: Response @@ -29115,8 +29452,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 - *19 - *17 responses: @@ -29134,9 +29471,9 @@ paths: type: integer repositories: type: array - items: *143 + items: *149 examples: - default: *155 + default: *161 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29157,8 +29494,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 requestBody: required: true content: @@ -29208,8 +29545,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 - name: repository_id in: path required: true @@ -29240,8 +29577,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 - name: repository_id in: path required: true @@ -29271,7 +29608,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: - - *63 + - *67 responses: '200': description: Response @@ -29279,7 +29616,7 @@ paths: application/json: schema: type: array - items: &237 + items: &243 title: Package description: A software package type: object @@ -29329,8 +29666,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *192 - required: *193 + properties: *198 + required: *199 nullable: true created_at: type: string @@ -29349,7 +29686,7 @@ paths: - created_at - updated_at examples: - default: &238 + default: &244 value: - id: 197 name: hello_docker @@ -29427,7 +29764,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *63 + - *67 - *17 - *19 responses: @@ -29437,7 +29774,7 @@ paths: application/json: schema: type: array - items: *94 + items: *98 examples: 200-response: value: @@ -29509,7 +29846,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *63 + - *67 - *17 - *19 responses: @@ -29519,7 +29856,7 @@ paths: application/json: schema: type: array - items: &216 + items: &222 title: Organization Invitation description: Organization Invitation type: object @@ -29566,7 +29903,7 @@ paths: - invitation_teams_url - node_id examples: - default: &217 + default: &223 value: - id: 1 login: monalisa @@ -29599,7 +29936,7 @@ paths: invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams invitation_source: member headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -29623,7 +29960,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *63 + - *67 - *17 - *19 responses: @@ -29633,7 +29970,7 @@ paths: application/json: schema: type: array - items: &194 + items: &200 title: Org Hook description: Org Hook type: object @@ -29721,7 +30058,7 @@ paths: created_at: '2011-09-06T17:26:27Z' type: Organization headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -29744,7 +30081,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *63 + - *67 requestBody: required: true content: @@ -29804,9 +30141,9 @@ paths: description: Response content: application/json: - schema: *194 + schema: *200 examples: - default: &195 + default: &201 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -29853,8 +30190,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *63 - - &196 + - *67 + - &202 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. @@ -29867,9 +30204,9 @@ paths: description: Response content: application/json: - schema: *194 + schema: *200 examples: - default: *195 + default: *201 '404': *6 x-github: githubCloudOnly: false @@ -29896,8 +30233,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *63 - - *196 + - *67 + - *202 requestBody: required: false content: @@ -29942,7 +30279,7 @@ paths: description: Response content: application/json: - schema: *194 + schema: *200 examples: default: value: @@ -29983,8 +30320,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *63 - - *196 + - *67 + - *202 responses: '204': description: Response @@ -30011,8 +30348,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *63 - - *196 + - *67 + - *202 responses: '200': description: Response @@ -30042,8 +30379,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *63 - - *196 + - *67 + - *202 requestBody: required: false content: @@ -30093,10 +30430,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *63 - - *196 + - *67 + - *202 - *17 - - *197 + - *203 responses: '200': description: Response @@ -30104,9 +30441,9 @@ paths: application/json: schema: type: array - items: *198 + items: *204 examples: - default: *199 + default: *205 '400': *14 '422': *15 x-github: @@ -30131,17 +30468,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *63 - - *196 + - *67 + - *202 - *16 responses: '200': description: Response content: application/json: - schema: *200 + schema: *206 examples: - default: *201 + default: *207 '400': *14 '422': *15 x-github: @@ -30166,8 +30503,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *63 - - *196 + - *67 + - *202 - *16 responses: '202': *39 @@ -30196,8 +30533,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *63 - - *196 + - *67 + - *202 responses: '204': description: Response @@ -30219,8 +30556,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *63 - - &206 + - *67 + - &212 name: actor_type in: path description: The type of the actor @@ -30233,14 +30570,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &207 + - &213 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &202 + - &208 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`.' @@ -30248,7 +30585,7 @@ paths: required: true schema: type: string - - &203 + - &209 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) @@ -30259,7 +30596,7 @@ paths: type: string - *19 - *17 - - *48 + - *52 - name: sort description: The property to sort the results by. in: query @@ -30341,13 +30678,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - - *63 - - *202 - - *203 + - *67 + - *208 + - *209 - *19 - *17 - - *48 - - &212 + - *52 + - &218 name: sort description: The property to sort the results by. in: query @@ -30425,15 +30762,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - - *63 - - *202 - - *203 + - *67 + - *208 + - *209 responses: '200': description: Response content: application/json: - schema: &204 + schema: &210 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -30449,7 +30786,7 @@ paths: type: integer format: int64 examples: - default: &205 + default: &211 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -30469,24 +30806,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *63 - - &208 + - *67 + - &214 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *202 - - *203 + - *208 + - *209 responses: '200': description: Response content: application/json: - schema: *204 + schema: *210 examples: - default: *205 + default: *211 x-github: enabledForGitHubApps: true category: orgs @@ -30504,19 +30841,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *63 - - *202 - - *203 - - *206 - - *207 + - *67 + - *208 + - *209 + - *212 + - *213 responses: '200': description: Response content: application/json: - schema: *204 + schema: *210 examples: - default: *205 + default: *211 x-github: enabledForGitHubApps: true category: orgs @@ -30533,10 +30870,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - - *63 - - *202 - - *203 - - &209 + - *67 + - *208 + - *209 + - &215 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -30549,7 +30886,7 @@ paths: description: Response content: application/json: - schema: &210 + schema: &216 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -30565,7 +30902,7 @@ paths: type: integer format: int64 examples: - default: &211 + default: &217 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -30601,19 +30938,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - - *63 + - *67 + - *214 - *208 - - *202 - - *203 - *209 + - *215 responses: '200': description: Response content: application/json: - schema: *210 + schema: *216 examples: - default: *211 + default: *217 x-github: enabledForGitHubApps: true category: orgs @@ -30630,20 +30967,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *63 - - *206 - - *207 - - *202 - - *203 + - *67 + - *212 + - *213 + - *208 - *209 + - *215 responses: '200': description: Response content: application/json: - schema: *210 + schema: *216 examples: - default: *211 + default: *217 x-github: enabledForGitHubApps: true category: orgs @@ -30660,14 +30997,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - - *63 + - *67 + - *214 - *208 - - *202 - - *203 + - *209 - *19 - *17 - - *48 - - *212 + - *52 + - *218 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -30740,7 +31077,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *63 + - *67 responses: '200': description: Response @@ -30748,7 +31085,7 @@ paths: application/json: schema: *22 examples: - default: &519 + default: &523 value: id: 1 account: @@ -30817,7 +31154,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *63 + - *67 - *17 - *19 responses: @@ -30887,7 +31224,7 @@ paths: suspended_at: suspended_by: headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30906,7 +31243,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response @@ -30914,12 +31251,12 @@ paths: application/json: schema: anyOf: - - &214 + - &220 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &213 + limit: &219 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -30944,7 +31281,7 @@ paths: properties: {} additionalProperties: false examples: - default: &215 + default: &221 value: limit: collaborators_only origin: organization @@ -30968,18 +31305,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *63 + - *67 requestBody: required: true content: application/json: - schema: &520 + schema: &524 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *213 + limit: *219 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -31003,9 +31340,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *220 examples: - default: *215 + default: *221 '422': *15 x-github: githubCloudOnly: false @@ -31023,7 +31360,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *63 + - *67 responses: '204': description: Response @@ -31047,7 +31384,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *63 + - *67 - *17 - *19 - name: role @@ -31081,11 +31418,11 @@ paths: application/json: schema: type: array - items: *216 + items: *222 examples: - default: *217 + default: *223 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -31106,7 +31443,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *63 + - *67 requestBody: required: false content: @@ -31160,7 +31497,7 @@ paths: description: Response content: application/json: - schema: *216 + schema: *222 examples: default: value: @@ -31214,8 +31551,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *63 - - &218 + - *67 + - &224 name: invitation_id description: The unique identifier of the invitation. in: path @@ -31245,8 +31582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *63 - - *218 + - *67 + - *224 - *17 - *19 responses: @@ -31256,9 +31593,9 @@ paths: application/json: schema: type: array - items: *181 + items: *187 examples: - default: &236 + default: &242 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -31274,7 +31611,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -31293,7 +31630,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response @@ -31301,7 +31638,7 @@ paths: application/json: schema: type: array - items: *219 + items: *225 examples: default: value: @@ -31339,7 +31676,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *63 + - *67 requestBody: required: true content: @@ -31386,9 +31723,9 @@ paths: description: Response content: application/json: - schema: *219 + schema: *225 examples: - default: &220 + default: &226 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -31420,8 +31757,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *63 - - &221 + - *67 + - &227 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -31474,9 +31811,9 @@ paths: description: Response content: application/json: - schema: *219 + schema: *225 examples: - default: *220 + default: *226 '404': *6 '422': *7 x-github: @@ -31500,8 +31837,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *63 - - *221 + - *67 + - *227 responses: '204': description: Response @@ -31534,7 +31871,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *63 + - *67 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -31564,7 +31901,7 @@ paths: - closed - all default: open - - *222 + - *228 - name: type description: Can be the name of an issue type. in: query @@ -31582,8 +31919,8 @@ paths: - updated - comments default: created - - *48 - - *72 + - *52 + - *76 - *17 - *19 responses: @@ -31593,11 +31930,11 @@ paths: application/json: schema: type: array - items: *82 + items: *86 examples: - default: *223 + default: *229 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -31617,7 +31954,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *63 + - *67 - 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) @@ -31655,9 +31992,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 '422': *15 x-github: githubCloudOnly: false @@ -31675,8 +32012,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: + - *67 - *63 - - *59 responses: '204': description: Response if requester is an organization member and user is @@ -31710,8 +32047,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: + - *67 - *63 - - *59 responses: '204': description: Response @@ -31737,8 +32074,8 @@ paths: parameters: - *17 - *19 + - *67 - *63 - - *59 responses: '200': description: Response @@ -31754,11 +32091,11 @@ paths: type: integer codespaces: type: array - items: *224 + items: *230 examples: - default: *225 + default: *231 '304': *37 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -31781,9 +32118,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: + - *67 - *63 - - *59 - - &226 + - &232 name: codespace_name in: path required: true @@ -31793,7 +32130,7 @@ paths: responses: '202': *39 '304': *37 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -31816,17 +32153,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: + - *67 - *63 - - *59 - - *226 + - *232 responses: '200': description: Response content: application/json: - schema: *224 + schema: *230 examples: - default: &447 + default: &451 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -31968,7 +32305,7 @@ paths: recent_folders: [] template: '304': *37 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -31999,14 +32336,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: + - *67 - *63 - - *59 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *227 + schema: *233 examples: default: value: @@ -32050,7 +32387,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -32075,14 +32412,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: + - *67 - *63 - - *59 responses: '200': description: Response content: application/json: - schema: &228 + schema: &234 title: Org Membership description: Org Membership type: object @@ -32126,7 +32463,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *61 + organization: *65 user: title: Simple User description: A GitHub user. @@ -32149,7 +32486,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &229 + response-if-user-has-an-active-admin-membership-with-organization: &235 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -32217,8 +32554,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: + - *67 - *63 - - *59 requestBody: required: false content: @@ -32246,9 +32583,9 @@ paths: description: Response content: application/json: - schema: *228 + schema: *234 examples: - response-if-user-already-had-membership-with-organization: *229 + response-if-user-already-had-membership-with-organization: *235 '422': *15 '403': *29 x-github: @@ -32272,8 +32609,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: + - *67 - *63 - - *59 responses: '204': description: Response @@ -32298,7 +32635,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *63 + - *67 - *17 - *19 - name: exclude @@ -32319,7 +32656,7 @@ paths: application/json: schema: type: array - items: &230 + items: &236 title: Migration description: A migration. type: object @@ -32360,7 +32697,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *66 + items: *70 url: type: string format: uri @@ -32556,7 +32893,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -32572,7 +32909,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *63 + - *67 requestBody: required: true content: @@ -32648,7 +32985,7 @@ paths: description: Response content: application/json: - schema: *230 + schema: *236 examples: default: value: @@ -32826,8 +33163,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *63 - - &231 + - *67 + - &237 name: migration_id description: The unique identifier of the migration. in: path @@ -32854,7 +33191,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *230 + schema: *236 examples: default: value: @@ -33023,8 +33360,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *63 - - *231 + - *67 + - *237 responses: '302': description: Response @@ -33045,8 +33382,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *63 - - *231 + - *67 + - *237 responses: '204': description: Response @@ -33069,9 +33406,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *63 - - *231 - - &679 + - *67 + - *237 + - &681 name: repo_name description: repo_name parameter in: path @@ -33098,8 +33435,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *63 - - *231 + - *67 + - *237 - *17 - *19 responses: @@ -33109,9 +33446,9 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: &243 + default: &249 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -33222,7 +33559,7 @@ paths: secret_scanning_non_provider_patterns: status: disabled headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -33248,7 +33585,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response - list of organization roles @@ -33264,7 +33601,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &233 + items: &239 title: Organization Role description: Organization roles type: object @@ -33411,8 +33748,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *63 - - *64 + - *67 + - *68 responses: '204': description: Response @@ -33437,9 +33774,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *63 - - *64 - - &232 + - *67 + - *68 + - &238 name: role_id description: The unique identifier of the role. in: path @@ -33474,9 +33811,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *63 - - *64 - - *232 + - *67 + - *68 + - *238 responses: '204': description: Response @@ -33501,8 +33838,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: + - *67 - *63 - - *59 responses: '204': description: Response @@ -33527,9 +33864,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: + - *67 - *63 - - *59 - - *232 + - *238 responses: '204': description: Response @@ -33559,9 +33896,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: + - *67 - *63 - - *59 - - *232 + - *238 responses: '204': description: Response @@ -33589,14 +33926,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *63 - - *232 + - *67 + - *238 responses: '200': description: Response content: application/json: - schema: *233 + schema: *239 examples: default: value: @@ -33646,8 +33983,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: - - *63 - - *232 + - *67 + - *238 - *17 - *19 responses: @@ -33725,8 +34062,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *234 - required: *235 + properties: *240 + required: *241 nullable: true type: description: The ownership type of the team @@ -33758,9 +34095,9 @@ paths: - type - parent examples: - default: *236 + default: *242 headers: - Link: *54 + Link: *58 '404': description: Response if the organization or role does not exist. '422': @@ -33787,8 +34124,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: - - *63 - - *232 + - *67 + - *238 - *17 - *19 responses: @@ -33816,13 +34153,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &305 + items: &312 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *234 - required: *235 + properties: *240 + required: *241 name: nullable: true type: string @@ -33917,9 +34254,9 @@ paths: - type - url examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 '404': description: Response if the organization or role does not exist. '422': @@ -33941,7 +34278,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *63 + - *67 - 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) @@ -33968,9 +34305,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33993,8 +34330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: + - *67 - *63 - - *59 requestBody: required: false content: @@ -34051,8 +34388,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: + - *67 - *63 - - *59 responses: '204': description: Response @@ -34109,8 +34446,8 @@ paths: - docker - nuget - container - - *63 - - &680 + - *67 + - &682 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -34146,12 +34483,12 @@ paths: application/json: schema: type: array - items: *237 + items: *243 examples: - default: *238 + default: *244 '403': *29 '401': *25 - '400': &682 + '400': &684 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -34173,7 +34510,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &239 + - &245 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 @@ -34191,20 +34528,20 @@ paths: - docker - nuget - container - - &240 + - &246 name: package_name description: The name of the package. in: path required: true schema: type: string - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: *237 + schema: *243 examples: default: value: @@ -34256,9 +34593,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *239 - - *240 - - *63 + - *245 + - *246 + - *67 responses: '204': description: Response @@ -34290,9 +34627,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *239 - - *240 - - *63 + - *245 + - *246 + - *67 - name: token description: package token schema: @@ -34324,9 +34661,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: - - *239 - - *240 - - *63 + - *245 + - *246 + - *67 - *19 - *17 - name: state @@ -34346,7 +34683,7 @@ paths: application/json: schema: type: array - items: &241 + items: &247 title: Package Version description: A version of a software package type: object @@ -34471,10 +34808,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *239 - - *240 - - *63 - - &242 + - *245 + - *246 + - *67 + - &248 name: package_version_id description: Unique identifier of the package version. in: path @@ -34486,7 +34823,7 @@ paths: description: Response content: application/json: - schema: *241 + schema: *247 examples: default: value: @@ -34522,10 +34859,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *239 - - *240 - - *63 - - *242 + - *245 + - *246 + - *67 + - *248 responses: '204': description: Response @@ -34557,10 +34894,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *239 - - *240 - - *63 - - *242 + - *245 + - *246 + - *67 + - *248 responses: '204': description: Response @@ -34587,10 +34924,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: - - *63 + - *67 - *17 - *19 - - &244 + - &250 name: sort description: The property by which to sort the results. in: query @@ -34600,8 +34937,8 @@ paths: enum: - created_at default: created_at - - *48 - - &245 + - *52 + - &251 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -34612,7 +34949,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &246 + - &252 name: repository description: The name of the repository to use to filter the results. in: query @@ -34620,7 +34957,7 @@ paths: schema: type: string example: Hello-World - - &247 + - &253 name: permission description: The permission to use to filter the results. in: query @@ -34628,7 +34965,7 @@ paths: schema: type: string example: issues_read - - &248 + - &254 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) @@ -34638,7 +34975,7 @@ paths: schema: type: string format: date-time - - &249 + - &255 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) @@ -34648,7 +34985,7 @@ paths: schema: type: string format: date-time - - &250 + - &256 name: token_id description: The ID of the token in: query @@ -34660,7 +34997,7 @@ paths: type: string example: token_id[]=1,token_id[]=2 responses: - '500': *103 + '500': *109 '422': *15 '404': *6 '403': *29 @@ -34792,7 +35129,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34812,7 +35149,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: - - *63 + - *67 requestBody: required: true content: @@ -34853,7 +35190,7 @@ paths: action: deny reason: Access is too broad. responses: - '500': *103 + '500': *109 '422': *15 '404': *6 '403': *29 @@ -34878,7 +35215,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: - - *63 + - *67 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -34914,11 +35251,11 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *103 + '500': *109 '422': *15 '404': *6 '403': *29 - '204': *175 + '204': *181 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34939,7 +35276,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: - - *63 + - *67 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -34950,7 +35287,7 @@ paths: - *17 - *19 responses: - '500': *103 + '500': *109 '404': *6 '403': *29 '200': @@ -34959,11 +35296,11 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: *243 + default: *249 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34984,19 +35321,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: - - *63 + - *67 - *17 - *19 - - *244 - - *48 - - *245 - - *246 - - *247 - - *248 - - *249 - *250 + - *52 + - *251 + - *252 + - *253 + - *254 + - *255 + - *256 responses: - '500': *103 + '500': *109 '422': *15 '404': *6 '403': *29 @@ -35123,7 +35460,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35143,7 +35480,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: - - *63 + - *67 requestBody: required: true content: @@ -35178,7 +35515,7 @@ paths: - 1296269 - 1296280 responses: - '500': *103 + '500': *109 '404': *6 '202': *39 '403': *29 @@ -35203,7 +35540,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: - - *63 + - *67 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -35231,9 +35568,9 @@ paths: value: action: revoke responses: - '500': *103 + '500': *109 '404': *6 - '204': *175 + '204': *181 '403': *29 '422': *15 x-github: @@ -35255,7 +35592,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: - - *63 + - *67 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -35265,7 +35602,7 @@ paths: - *17 - *19 responses: - '500': *103 + '500': *109 '404': *6 '403': *29 '200': @@ -35274,11 +35611,11 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: *243 + default: *249 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35300,7 +35637,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *63 + - *67 - *17 - *19 responses: @@ -35318,7 +35655,7 @@ paths: type: integer configurations: type: array - items: &251 + items: &257 title: Organization private registry description: Private registry configuration for an organization type: object @@ -35398,7 +35735,7 @@ paths: updated_at: '2020-01-10T14:59:22Z' visibility: selected headers: - Link: *54 + Link: *58 '400': *14 '404': *6 x-github: @@ -35420,7 +35757,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *63 + - *67 requestBody: required: true content: @@ -35608,7 +35945,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &252 + org-private-registry-with-selected-visibility: &258 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -35649,7 +35986,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: - - *63 + - *67 responses: '200': description: Response @@ -35675,7 +36012,7 @@ paths: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -35697,16 +36034,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *63 - - *151 + - *67 + - *157 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *251 + schema: *257 examples: - default: *252 + default: *258 '404': *6 x-github: githubCloudOnly: false @@ -35727,8 +36064,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *63 - - *151 + - *67 + - *157 requestBody: required: true content: @@ -35832,8 +36169,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *63 - - *151 + - *67 + - *157 responses: '204': description: Response @@ -35856,15 +36193,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-organization parameters: - - *63 + - *67 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *40 - - *41 + - *45 + - *46 - *17 responses: '200': @@ -35873,7 +36210,7 @@ paths: application/json: schema: type: array - items: &253 + items: &259 title: Projects v2 Project description: A projects v2 project type: object @@ -35943,7 +36280,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &756 + properties: &767 id: type: number description: The unique identifier of the status update. @@ -35991,7 +36328,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &757 + required: &768 - id - node_id - created_at @@ -36016,7 +36353,7 @@ paths: - deleted_at - deleted_by examples: - default: &254 + default: &260 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -36099,7 +36436,7 @@ paths: updated_at: '2025-07-11T16:19:28Z' is_template: true headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -36119,24 +36456,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &255 + - &261 name: project_number description: The project's number. in: path required: true schema: type: integer - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: *253 + schema: *259 examples: - default: *254 + default: *260 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -36156,8 +36493,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - - *63 - - *255 + - *67 + - *261 requestBody: required: true description: Details of the draft item to create in the project. @@ -36191,7 +36528,7 @@ paths: description: Response content: application/json: - schema: &261 + schema: &267 title: Projects v2 Item description: An item belonging to a project type: object @@ -36204,8 +36541,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *82 - - &462 + - *86 + - &466 title: Pull Request Simple description: Pull Request Simple type: object @@ -36311,8 +36648,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *256 - required: *257 + properties: *262 + required: *263 nullable: true active_lock_reason: type: string @@ -36357,7 +36694,7 @@ paths: nullable: true requested_teams: type: array - items: *181 + items: *187 nullable: true head: type: object @@ -36366,7 +36703,7 @@ paths: type: string ref: type: string - repo: *66 + repo: *70 sha: type: string user: @@ -36389,7 +36726,7 @@ paths: type: string ref: type: string - repo: *66 + repo: *70 sha: type: string user: @@ -36408,7 +36745,7 @@ paths: _links: type: object properties: - comments: &258 + comments: &264 title: Link description: Hypermedia Link type: object @@ -36417,13 +36754,13 @@ paths: type: string required: - href - commits: *258 - statuses: *258 - html: *258 - issue: *258 - review_comments: *258 - review_comment: *258 - self: *258 + commits: *264 + statuses: *264 + html: *264 + issue: *264 + review_comments: *264 + review_comment: *264 + self: *264 required: - comments - commits @@ -36433,8 +36770,8 @@ paths: - review_comments - review_comment - self - author_association: *69 - auto_merge: &568 + author_association: *73 + auto_merge: &572 title: Auto merge description: The status of auto merging a pull request. type: object @@ -36536,7 +36873,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &260 + content_type: &266 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -36576,7 +36913,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &262 + draft_issue: &268 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -36650,11 +36987,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *255 - - *63 + - *261 + - *67 - *17 - - *40 - - *41 + - *45 + - *46 responses: '200': description: Response @@ -36662,7 +36999,7 @@ paths: application/json: schema: type: array - items: &259 + items: &265 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -36809,7 +37146,7 @@ paths: - updated_at - project_url examples: - default: &699 + default: &701 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -36920,7 +37257,7 @@ paths: created_at: '2022-06-20T16:45:00Z' updated_at: '2022-06-20T16:45:00Z' headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -36929,6 +37266,296 @@ 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: + - *261 + - *67 + 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: &702 + 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: &703 + 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: &704 + 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: &705 + 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: *265 + examples: + text_field: &706 + 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: &707 + 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: &708 + 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: &709 + 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: &710 + 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': *37 + '403': *29 + '401': *25 + '422': *15 + 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 @@ -36940,23 +37567,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *255 - - &700 + - *261 + - &711 name: field_id description: The unique identifier of the field. in: path required: true schema: type: integer - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: *259 + schema: *265 examples: - default: &701 + default: &712 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -36965,21 +37592,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: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -37000,8 +37639,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *255 - - *63 + - *261 + - *67 - 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. @@ -37023,8 +37662,8 @@ paths: maxItems: 50 items: type: string - - *40 - - *41 + - *45 + - *46 - *17 responses: '200': @@ -37033,7 +37672,7 @@ paths: application/json: schema: type: array - items: &263 + items: &269 title: Projects v2 Item description: An item belonging to a project type: object @@ -37049,7 +37688,7 @@ paths: format: uri example: https://api.github.com/users/monalisa/2/projectsV2/3 description: The API URL of the project that contains this item. - content_type: *260 + content_type: *266 content: type: object additionalProperties: true @@ -37092,7 +37731,7 @@ paths: - updated_at - archived_at examples: - default: &264 + default: &270 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -37768,7 +38407,7 @@ paths: type: sub_issues_progress value: headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -37788,8 +38427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - - *63 - - *255 + - *67 + - *261 requestBody: required: true description: Details of the item to add to the project. @@ -37826,10 +38465,10 @@ paths: description: Response content: application/json: - schema: *261 + schema: *267 examples: - issue: *262 - pull_request: *262 + issue: *268 + pull_request: *268 '304': *37 '403': *29 '401': *25 @@ -37849,9 +38488,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *255 - - *63 - - &265 + - *261 + - *67 + - &271 name: item_id description: The unique identifier of the project item. in: path @@ -37877,11 +38516,11 @@ paths: description: Response content: application/json: - schema: *263 + schema: *269 examples: - default: *264 + default: *270 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -37900,9 +38539,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *255 - - *63 - - *265 + - *261 + - *67 + - *271 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -37972,13 +38611,13 @@ paths: description: Response content: application/json: - schema: *263 + schema: *269 examples: - text_field: *264 - number_field: *264 - date_field: *264 - single_select_field: *264 - iteration_field: *264 + text_field: *270 + number_field: *270 + date_field: *270 + single_select_field: *270 + iteration_field: *270 '401': *25 '403': *29 '404': *6 @@ -37998,9 +38637,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *255 - - *63 - - *265 + - *261 + - *67 + - *271 responses: '204': description: Response @@ -38024,7 +38663,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response @@ -38032,7 +38671,7 @@ paths: application/json: schema: type: array - items: &266 + items: &272 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -38096,7 +38735,7 @@ paths: - property_name - value_type examples: - default: &267 + default: &273 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -38144,7 +38783,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *63 + - *67 requestBody: required: true content: @@ -38155,7 +38794,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *266 + items: *272 minItems: 1 maxItems: 100 required: @@ -38185,9 +38824,9 @@ paths: application/json: schema: type: array - items: *266 + items: *272 examples: - default: *267 + default: *273 '403': *29 '404': *6 x-github: @@ -38208,8 +38847,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *63 - - &268 + - *67 + - &274 name: custom_property_name description: The custom property name in: path @@ -38221,9 +38860,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *272 examples: - default: &269 + default: &275 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -38257,8 +38896,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: - - *63 - - *268 + - *67 + - *274 requestBody: required: true content: @@ -38325,9 +38964,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *272 examples: - default: *269 + default: *275 '403': *29 '404': *6 x-github: @@ -38350,10 +38989,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *63 - - *268 + - *67 + - *274 responses: - '204': *175 + '204': *181 '403': *29 '404': *6 x-github: @@ -38374,7 +39013,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *63 + - *67 - *17 - *19 - name: repository_query @@ -38412,7 +39051,7 @@ paths: example: octocat/Hello-World properties: type: array - items: *102 + items: *108 description: List of custom property names and associated values required: - repository_id @@ -38433,7 +39072,7 @@ paths: - property_name: team value: octocat headers: - Link: *54 + Link: *58 '403': *29 '404': *6 x-github: @@ -38461,7 +39100,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: - - *63 + - *67 requestBody: required: true content: @@ -38481,7 +39120,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *102 + items: *108 required: - repository_names - properties @@ -38522,7 +39161,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *63 + - *67 - *17 - *19 responses: @@ -38534,9 +39173,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38553,8 +39192,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: + - *67 - *63 - - *59 responses: '204': description: Response if user is a public member @@ -38578,8 +39217,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: + - *67 - *63 - - *59 responses: '204': description: Response @@ -38600,8 +39239,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: + - *67 - *63 - - *59 responses: '204': description: Response @@ -38625,7 +39264,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *63 + - *67 - name: type description: Specifies the types of repositories you want returned. in: query @@ -38671,11 +39310,11 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: *243 + default: *249 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38694,7 +39333,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *63 + - *67 requestBody: required: true content: @@ -38875,7 +39514,7 @@ paths: description: Response content: application/json: - schema: &333 + schema: &335 title: Full Repository description: Full Repository type: object @@ -39152,8 +39791,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *270 - required: *271 + properties: *276 + required: *277 nullable: true temp_clone_token: type: string @@ -39240,8 +39879,8 @@ paths: title: License Simple description: License Simple type: object - properties: *83 - required: *84 + properties: *87 + required: *88 nullable: true organization: title: Simple User @@ -39250,8 +39889,8 @@ paths: properties: *20 required: *21 nullable: true - parent: *66 - source: *66 + parent: *70 + source: *70 forks: type: integer master_branch: @@ -39268,7 +39907,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &467 + properties: &471 url: type: string format: uri @@ -39284,12 +39923,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &468 + required: &472 - url - key - name - html_url - security_and_analysis: *272 + security_and_analysis: *278 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -39373,7 +40012,7 @@ paths: - network_count - subscribers_count examples: - default: &335 + default: &337 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -39891,10 +40530,10 @@ paths: category: orgs subcategory: rules parameters: - - *63 + - *67 - *17 - *19 - - &591 + - &594 name: targets description: | A comma-separated list of rule targets to filter by. @@ -39912,7 +40551,7 @@ paths: application/json: schema: type: array - items: &298 + items: &305 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -39947,7 +40586,7 @@ paths: source: type: string description: The name of the source - enforcement: &275 + enforcement: &281 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -39960,7 +40599,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &276 + items: &282 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -40030,7 +40669,7 @@ paths: conditions: nullable: true anyOf: - - &273 + - &279 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -40054,7 +40693,7 @@ paths: match. items: type: string - - &277 + - &283 title: Organization ruleset conditions type: object description: |- @@ -40068,7 +40707,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *273 + - *279 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -40102,7 +40741,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *273 + - *279 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -40124,7 +40763,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *273 + - *279 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -40137,7 +40776,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &274 + items: &280 title: Repository ruleset property targeting definition type: object @@ -40170,17 +40809,17 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *274 + items: *280 required: - repository_property rules: type: array - items: &592 + items: &595 title: Repository Rule type: object description: A repository rule. oneOf: - - &278 + - &284 title: creation description: Only allow users with bypass permission to create matching refs. @@ -40192,7 +40831,7 @@ paths: type: string enum: - creation - - &279 + - &285 title: update description: Only allow users with bypass permission to update matching refs. @@ -40213,7 +40852,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &280 + - &286 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -40225,7 +40864,7 @@ paths: type: string enum: - deletion - - &281 + - &287 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -40237,7 +40876,7 @@ paths: type: string enum: - required_linear_history - - &589 + - &593 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -40315,7 +40954,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &282 + - &288 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -40339,7 +40978,7 @@ paths: type: string required: - required_deployment_environments - - &283 + - &289 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -40351,7 +40990,7 @@ paths: type: string enum: - required_signatures - - &284 + - &290 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -40462,7 +41101,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &285 + - &291 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -40510,7 +41149,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &286 + - &292 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -40522,7 +41161,7 @@ paths: type: string enum: - non_fast_forward - - &287 + - &293 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -40558,7 +41197,7 @@ paths: required: - operator - pattern - - &288 + - &294 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -40594,7 +41233,7 @@ paths: required: - operator - pattern - - &289 + - &295 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -40630,7 +41269,7 @@ paths: required: - operator - pattern - - &290 + - &296 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -40666,7 +41305,7 @@ paths: required: - operator - pattern - - &291 + - &297 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -40702,7 +41341,7 @@ paths: required: - operator - pattern - - &292 + - &298 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -40727,7 +41366,7 @@ paths: type: string required: - restricted_file_paths - - &293 + - &299 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -40751,7 +41390,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &294 + - &300 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -40774,7 +41413,7 @@ paths: type: string required: - restricted_file_extensions - - &295 + - &301 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -40799,7 +41438,7 @@ paths: maximum: 100 required: - max_file_size - - &296 + - &302 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -40849,7 +41488,7 @@ paths: - repository_id required: - workflows - - &297 + - &303 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -40910,7 +41549,7 @@ paths: - tool required: - code_scanning_tools - - &590 + - &304 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -40971,7 +41610,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *103 + '500': *109 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -40987,7 +41626,7 @@ paths: category: orgs subcategory: rules parameters: - - *63 + - *67 requestBody: description: Request body required: true @@ -41008,26 +41647,20 @@ paths: - push - repository default: branch - enforcement: *275 + enforcement: *281 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *276 - conditions: *277 + items: *282 + conditions: *283 rules: type: array description: An array of rules within the ruleset. - items: &300 + items: &307 title: Repository Rule type: object description: A repository rule. oneOf: - - *278 - - *279 - - *280 - - *281 - - *282 - - *283 - *284 - *285 - *286 @@ -41042,6 +41675,13 @@ paths: - *295 - *296 - *297 + - *298 + - *299 + - *300 + - *301 + - *302 + - *303 + - *304 required: - name - enforcement @@ -41079,9 +41719,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: &299 + default: &306 value: id: 21 name: super cool ruleset @@ -41121,7 +41761,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *103 + '500': *109 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -41135,8 +41775,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *63 - - &593 + - *67 + - &596 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 @@ -41151,7 +41791,7 @@ paths: in: query schema: type: string - - &594 + - &597 name: time_period description: |- The time period to filter by. @@ -41167,14 +41807,14 @@ paths: - week - month default: day - - &595 + - &598 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &596 + - &599 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -41194,7 +41834,7 @@ paths: description: Response content: application/json: - schema: &597 + schema: &600 title: Rule Suites description: Response type: array @@ -41249,7 +41889,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &598 + default: &601 value: - id: 21 actor_id: 12 @@ -41273,7 +41913,7 @@ paths: result: pass evaluation_result: fail '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41292,8 +41932,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *63 - - &599 + - *67 + - &602 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -41309,7 +41949,7 @@ paths: description: Response content: application/json: - schema: &600 + schema: &603 title: Rule Suite description: Response type: object @@ -41408,7 +42048,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &601 + default: &604 value: id: 21 actor_id: 12 @@ -41443,7 +42083,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41469,7 +42109,7 @@ paths: category: orgs subcategory: rules parameters: - - *63 + - *67 - name: ruleset_id description: The ID of the ruleset. in: path @@ -41481,11 +42121,11 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 '404': *6 - '500': *103 + '500': *109 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -41501,7 +42141,7 @@ paths: category: orgs subcategory: rules parameters: - - *63 + - *67 - name: ruleset_id description: The ID of the ruleset. in: path @@ -41527,16 +42167,16 @@ paths: - tag - push - repository - enforcement: *275 + enforcement: *281 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *276 - conditions: *277 + items: *282 + conditions: *283 rules: description: An array of rules within the ruleset. type: array - items: *300 + items: *307 examples: default: value: @@ -41571,11 +42211,11 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 '404': *6 - '500': *103 + '500': *109 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -41591,7 +42231,7 @@ paths: category: orgs subcategory: rules parameters: - - *63 + - *67 - name: ruleset_id description: The ID of the ruleset. in: path @@ -41602,7 +42242,7 @@ paths: '204': description: Response '404': *6 - '500': *103 + '500': *109 "/orgs/{org}/rulesets/{ruleset_id}/history": get: summary: Get organization ruleset history @@ -41614,7 +42254,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history parameters: - - *63 + - *67 - *17 - *19 - name: ruleset_id @@ -41630,7 +42270,7 @@ paths: application/json: schema: type: array - items: &301 + items: &308 title: Ruleset version type: object description: The historical version of a ruleset @@ -41654,7 +42294,7 @@ paths: type: string format: date-time examples: - default: &603 + default: &606 value: - version_id: 3 actor: @@ -41672,7 +42312,7 @@ paths: type: User updated_at: '2024-08-23T16:29:47Z' '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41689,7 +42329,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version parameters: - - *63 + - *67 - name: ruleset_id description: The ID of the ruleset. in: path @@ -41707,9 +42347,9 @@ paths: description: Response content: application/json: - schema: &604 + schema: &607 allOf: - - *301 + - *308 - type: object required: - state @@ -41756,7 +42396,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41778,8 +42418,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *63 - - &605 + - *67 + - &608 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -41790,7 +42430,7 @@ paths: enum: - open - resolved - - &606 + - &609 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -41800,7 +42440,7 @@ paths: required: false schema: type: string - - &607 + - &610 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -41809,7 +42449,26 @@ paths: required: false schema: type: string - - &608 + - &611 + 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 + - &612 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. @@ -41821,10 +42480,10 @@ paths: - created - updated default: created - - *48 + - *52 - *19 - *17 - - &609 + - &613 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 @@ -41834,7 +42493,7 @@ paths: required: false schema: type: string - - &610 + - &614 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 @@ -41844,7 +42503,7 @@ paths: required: false schema: type: string - - &611 + - &615 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -41853,7 +42512,7 @@ paths: required: false schema: type: string - - &612 + - &616 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -41862,7 +42521,7 @@ paths: schema: type: boolean default: false - - &613 + - &617 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -41871,7 +42530,7 @@ paths: schema: type: boolean default: false - - &614 + - &618 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -41890,8 +42549,8 @@ paths: items: type: object properties: - number: *161 - created_at: *162 + number: *167 + created_at: *168 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -41899,21 +42558,21 @@ paths: format: date-time readOnly: true nullable: true - url: *164 - html_url: *165 + url: *170 + html_url: *171 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &615 + state: &619 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: &616 + resolution: &620 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -41947,7 +42606,7 @@ paths: secret: type: string description: The secret that was detected. - repository: *53 + repository: *57 push_protection_bypassed: type: boolean description: Whether push protection was bypassed for the detected @@ -42020,8 +42679,8 @@ paths: pull request. ' - oneOf: &617 - - &619 + oneOf: &621 + - &623 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -42073,7 +42732,7 @@ paths: - blob_url - commit_sha - commit_url - - &620 + - &624 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. @@ -42128,7 +42787,7 @@ paths: - page_url - commit_sha - commit_url - - &621 + - &625 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -42142,7 +42801,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &622 + - &626 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -42156,7 +42815,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &623 + - &627 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -42170,7 +42829,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &624 + - &628 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -42184,7 +42843,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &625 + - &629 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -42198,7 +42857,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &626 + - &630 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -42212,7 +42871,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &627 + - &631 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. @@ -42226,7 +42885,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &628 + - &632 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. @@ -42240,7 +42899,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &629 + - &633 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. @@ -42254,7 +42913,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &630 + - &634 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. @@ -42268,7 +42927,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &631 + - &635 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. @@ -42471,9 +43130,9 @@ paths: type: User site_admin: false headers: - Link: *54 + Link: *58 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42498,7 +43157,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *63 + - *67 responses: '200': description: Response @@ -42510,7 +43169,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &303 + pattern_config_version: &310 type: string description: The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate @@ -42519,7 +43178,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &302 + items: &309 type: object properties: token_type: @@ -42585,7 +43244,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *302 + items: *309 examples: default: value: @@ -42634,7 +43293,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *63 + - *67 requestBody: required: true content: @@ -42642,7 +43301,7 @@ paths: schema: type: object properties: - pattern_config_version: *303 + pattern_config_version: *310 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -42668,7 +43327,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *303 + custom_pattern_version: *310 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -42704,7 +43363,7 @@ paths: '400': *14 '403': *29 '404': *6 - '409': *47 + '409': *51 '422': *15 "/orgs/{org}/security-advisories": get: @@ -42722,8 +43381,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *63 - - *48 + - *67 + - *52 - name: sort description: The property to sort the results by. in: query @@ -42735,8 +43394,8 @@ paths: - updated - published default: created - - *40 - - *41 + - *45 + - *46 - 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)." @@ -42766,7 +43425,7 @@ paths: application/json: schema: type: array - items: &635 + items: &639 description: A repository security advisory. type: object properties: @@ -42953,7 +43612,7 @@ paths: required: - vector_string - score - cvss_severities: *50 + cvss_severities: *54 cwes: type: array nullable: true @@ -42986,7 +43645,7 @@ paths: login: type: string description: The username of the user credited. - type: *304 + type: *311 credits_detailed: type: array nullable: true @@ -42996,7 +43655,7 @@ paths: type: object properties: user: *4 - type: *304 + type: *311 state: type: string description: The state of the user's acceptance of the @@ -43020,14 +43679,14 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *181 + items: *187 private_fork: readOnly: true nullable: true description: A temporary private fork of the advisory's repository for collaborating on a fix. allOf: - - *53 + - *57 required: - ghsa_id - cve_id @@ -43057,7 +43716,7 @@ paths: - private_fork additionalProperties: false examples: - default: &636 + default: &640 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -43436,7 +44095,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *63 + - *67 responses: '200': description: Response @@ -43444,9 +44103,9 @@ paths: application/json: schema: type: array - items: *305 + items: *312 examples: - default: *236 + default: *242 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43469,8 +44128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *63 - - *64 + - *67 + - *68 responses: '204': description: Response @@ -43495,8 +44154,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *63 - - *64 + - *67 + - *68 responses: '204': description: Response @@ -43523,7 +44182,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Immutable releases settings response @@ -43572,7 +44231,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization parameters: - - *63 + - *67 responses: '204': description: Response @@ -43629,7 +44288,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - - *63 + - *67 - *19 - *17 responses: @@ -43647,9 +44306,9 @@ paths: type: integer repositories: type: array - items: *143 + items: *149 examples: - default: *155 + default: *161 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43668,7 +44327,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement parameters: - - *63 + - *67 requestBody: required: true content: @@ -43717,8 +44376,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: - - *63 - - *132 + - *67 + - *138 responses: '204': description: Response @@ -43740,8 +44399,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: - - *63 - - *132 + - *67 + - *138 responses: '204': description: Response @@ -43764,7 +44423,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *63 + - *67 - *17 - *19 responses: @@ -43782,7 +44441,7 @@ paths: type: integer network_configurations: type: array - items: &306 + items: &313 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -43841,7 +44500,7 @@ paths: - 6789ABDCEF12345 created_on: '2023-04-26T15:23:37Z' headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43860,7 +44519,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: - - *63 + - *67 requestBody: required: true content: @@ -43902,9 +44561,9 @@ paths: description: Response content: application/json: - schema: *306 + schema: *313 examples: - default: &307 + default: &314 value: id: 123456789ABCDEF name: My network configuration @@ -43932,8 +44591,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: - - *63 - - &308 + - *67 + - &315 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -43945,11 +44604,11 @@ paths: description: Response content: application/json: - schema: *306 + schema: *313 examples: - default: *307 + default: *314 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43968,8 +44627,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: - - *63 - - *308 + - *67 + - *315 requestBody: required: true content: @@ -44008,9 +44667,9 @@ paths: description: Response content: application/json: - schema: *306 + schema: *313 examples: - default: *307 + default: *314 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44029,8 +44688,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: - - *63 - - *308 + - *67 + - *315 responses: '204': description: Response @@ -44053,7 +44712,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: - - *63 + - *67 - name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -44107,7 +44766,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: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44137,8 +44796,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *63 - - *64 + - *67 + - *68 - 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`). @@ -44170,13 +44829,13 @@ paths: application/json: schema: type: array - items: *309 + items: *316 examples: - default: *310 - '500': *103 + default: *317 + '500': *109 '403': *29 '404': *6 - '422': *311 + '422': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44194,7 +44853,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *63 + - *67 - *17 - *19 responses: @@ -44204,11 +44863,11 @@ paths: application/json: schema: type: array - items: *181 + items: *187 examples: - default: *236 + default: *242 headers: - Link: *54 + Link: *58 '403': *29 x-github: githubCloudOnly: false @@ -44228,7 +44887,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *63 + - *67 requestBody: required: true content: @@ -44300,7 +44959,7 @@ paths: description: Response content: application/json: - schema: &312 + schema: &319 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -44363,8 +45022,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *234 - required: *235 + properties: *240 + required: *241 nullable: true members_count: type: integer @@ -44627,7 +45286,7 @@ paths: - repos_count - organization examples: - default: &313 + default: &320 value: id: 1 node_id: MDQ6VGVhbTE= @@ -44697,16 +45356,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *63 - - *64 + - *67 + - *68 responses: '200': description: Response content: application/json: - schema: *312 + schema: *319 examples: - default: *313 + default: *320 '404': *6 x-github: githubCloudOnly: false @@ -44727,8 +45386,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *63 - - *64 + - *67 + - *68 requestBody: required: false content: @@ -44790,16 +45449,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *312 + schema: *319 examples: - default: *313 + default: *320 '201': description: Response content: application/json: - schema: *312 + schema: *319 examples: - default: *313 + default: *320 '404': *6 '422': *15 '403': *29 @@ -44824,8 +45483,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *63 - - *64 + - *67 + - *68 responses: '204': description: Response @@ -44851,9 +45510,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - - *63 - - *64 - - *48 + - *67 + - *68 + - *52 - *17 - *19 - name: pinned @@ -44869,7 +45528,7 @@ paths: application/json: schema: type: array - items: &314 + items: &321 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -44948,7 +45607,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *70 + reactions: *74 required: - author - body @@ -44968,7 +45627,7 @@ paths: - updated_at - url examples: - default: &653 + default: &657 value: - author: login: octocat @@ -45018,7 +45677,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45042,8 +45701,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - - *63 - - *64 + - *67 + - *68 requestBody: required: true content: @@ -45077,9 +45736,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: &315 + default: &322 value: author: login: octocat @@ -45151,9 +45810,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - - *63 - - *64 - - &316 + - *67 + - *68 + - &323 name: discussion_number description: The number that identifies the discussion. in: path @@ -45165,9 +45824,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45189,9 +45848,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - - *63 - - *64 - - *316 + - *67 + - *68 + - *323 requestBody: required: false content: @@ -45214,9 +45873,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: &654 + default: &658 value: author: login: octocat @@ -45286,9 +45945,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - - *63 - - *64 - - *316 + - *67 + - *68 + - *323 responses: '204': description: Response @@ -45314,10 +45973,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - - *63 - - *64 - - *316 - - *48 + - *67 + - *68 + - *323 + - *52 - *17 - *19 responses: @@ -45327,7 +45986,7 @@ paths: application/json: schema: type: array - items: &317 + items: &324 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -45384,7 +46043,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *70 + reactions: *74 required: - author - body @@ -45399,7 +46058,7 @@ paths: - updated_at - url examples: - default: &655 + default: &659 value: - author: login: octocat @@ -45443,7 +46102,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45467,9 +46126,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *63 - - *64 - - *316 + - *67 + - *68 + - *323 requestBody: required: true content: @@ -45491,9 +46150,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *324 examples: - default: &318 + default: &325 value: author: login: octocat @@ -45559,10 +46218,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *63 - - *64 - - *316 - - &319 + - *67 + - *68 + - *323 + - &326 name: comment_number description: The number that identifies the comment. in: path @@ -45574,9 +46233,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *324 examples: - default: *318 + default: *325 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45598,10 +46257,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *63 - - *64 - - *316 - - *319 + - *67 + - *68 + - *323 + - *326 requestBody: required: true content: @@ -45623,9 +46282,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *324 examples: - default: &656 + default: &660 value: author: login: octocat @@ -45689,10 +46348,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *63 - - *64 - - *316 - - *319 + - *67 + - *68 + - *323 + - *326 responses: '204': description: Response @@ -45718,10 +46377,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *63 - - *64 - - *316 - - *319 + - *67 + - *68 + - *323 + - *326 - 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. @@ -45747,7 +46406,7 @@ paths: application/json: schema: type: array - items: &320 + items: &327 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -45790,7 +46449,7 @@ paths: - content - created_at examples: - default: &322 + default: &329 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -45816,7 +46475,7 @@ paths: content: heart created_at: '2016-05-20T20:09:31Z' headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45840,10 +46499,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *63 - - *64 - - *316 - - *319 + - *67 + - *68 + - *323 + - *326 requestBody: required: true content: @@ -45876,9 +46535,9 @@ paths: team discussion comment content: application/json: - schema: *320 + schema: *327 examples: - default: &321 + default: &328 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -45907,9 +46566,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45932,11 +46591,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *63 - - *64 - - *316 - - *319 - - &323 + - *67 + - *68 + - *323 + - *326 + - &330 name: reaction_id description: The unique identifier of the reaction. in: path @@ -45968,9 +46627,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *63 - - *64 - - *316 + - *67 + - *68 + - *323 - 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. @@ -45996,11 +46655,11 @@ paths: application/json: schema: type: array - items: *320 + items: *327 examples: - default: *322 + default: *329 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46024,9 +46683,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *63 - - *64 - - *316 + - *67 + - *68 + - *323 requestBody: required: true content: @@ -46058,16 +46717,16 @@ paths: description: Response content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '201': description: Response content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -46090,10 +46749,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *63 - - *64 - - *316 + - *67 + - *68 - *323 + - *330 responses: '204': description: Response @@ -46117,8 +46776,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *63 - - *64 + - *67 + - *68 - *17 - *19 responses: @@ -46128,11 +46787,11 @@ paths: application/json: schema: type: array - items: *216 + items: *222 examples: - default: *217 + default: *223 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46152,8 +46811,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *63 - - *64 + - *67 + - *68 - name: role description: Filters members returned by their role in the team. in: query @@ -46176,9 +46835,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46206,15 +46865,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: + - *67 + - *68 - *63 - - *64 - - *59 responses: '200': description: Response content: application/json: - schema: &324 + schema: &331 title: Team Membership description: Team Membership type: object @@ -46241,7 +46900,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &657 + response-if-user-is-a-team-maintainer: &661 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -46277,9 +46936,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: + - *67 + - *68 - *63 - - *64 - - *59 requestBody: required: false content: @@ -46304,9 +46963,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *331 examples: - response-if-users-membership-with-team-is-now-pending: &658 + response-if-users-membership-with-team-is-now-pending: &662 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -46341,9 +47000,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: + - *67 + - *68 - *63 - - *64 - - *59 responses: '204': description: Response @@ -46354,322 +47013,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: - - *63 - - *64 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &325 - 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 - nullable: true - 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: &659 - 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: *54 - 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: - - *63 - - *64 - - &326 - 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: *325 - examples: - default: &660 - 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: - - *63 - - *64 - - *326 - 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 - nullable: true - 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: - - *63 - - *64 - - *326 - 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 @@ -46685,8 +47028,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *63 - - *64 + - *67 + - *68 - *17 - *19 responses: @@ -46696,11 +47039,11 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: *243 + default: *249 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46727,16 +47070,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *63 - - *64 - - *327 - - *328 + - *67 + - *68 + - *332 + - *333 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &661 + schema: &663 title: Team Repository description: A team's access to a repository. type: object @@ -46759,8 +47102,8 @@ paths: title: License Simple description: License Simple type: object - properties: *83 - required: *84 + properties: *87 + required: *88 nullable: true forks: type: integer @@ -47305,10 +47648,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *63 - - *64 - - *327 - - *328 + - *67 + - *68 + - *332 + - *333 requestBody: required: false content: @@ -47353,10 +47696,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *63 - - *64 - - *327 - - *328 + - *67 + - *68 + - *332 + - *333 responses: '204': description: Response @@ -47380,8 +47723,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *63 - - *64 + - *67 + - *68 - *17 - *19 responses: @@ -47391,9 +47734,9 @@ paths: application/json: schema: type: array - items: *181 + items: *187 examples: - response-if-child-teams-exist: &662 + response-if-child-teams-exist: &664 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -47421,7 +47764,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47446,7 +47789,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *63 + - *67 - name: security_product in: path description: The security feature to enable or disable. @@ -47506,455 +47849,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: - - &329 - 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: &330 - title: Project Column - description: Project columns contain cards of work. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - cards_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - example: 42 - type: integer - node_id: - type: string - example: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - example: Remaining tasks - type: string - created_at: - type: string - format: date-time - example: '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - example: '2016-09-05T14:22:28Z' - required: - - id - - node_id - - url - - project_url - - cards_url - - name - - created_at - - updated_at - examples: - default: &331 - 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': *37 - '403': *29 - '404': *6 - '401': *25 - 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: - - *329 - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project column - example: Remaining tasks - type: string - required: - - name - type: object - examples: - default: - summary: Rename the project column - value: - name: To Do - responses: - '200': - description: Response - content: - application/json: - schema: *330 - examples: - default: *331 - '304': *37 - '403': *29 - '401': *25 - 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: - - *329 - responses: - '204': - description: Response - '304': *37 - '403': *29 - '401': *25 - 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: - - *329 - 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.' - example: last - type: string - pattern: "^(?:first|last|after:\\d+)$" - 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': *37 - '403': *29 - '422': *7 - '401': *25 - 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: - - *326 - - 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: *58 - headers: - Link: *54 - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - 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: - - *326 - - *59 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - example: write - type: string - nullable: true - examples: - default: - summary: Applying write permissions for the new collaborator - value: - permission: write - responses: - '204': - description: Response - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - 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: - - *326 - - *59 - responses: - '204': - description: Response - '304': *37 - '404': *6 - '403': *29 - '422': *15 - '401': *25 - 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: - - *326 - - *59 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Project Collaborator Permission - description: Project Collaborator Permission - type: object - properties: - permission: - type: string - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - 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': *37 - '403': *29 - '401': *25 - 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 @@ -47996,7 +47890,7 @@ paths: resources: type: object properties: - core: &332 + core: &334 title: Rate Limit type: object properties: @@ -48013,21 +47907,21 @@ paths: - remaining - reset - used - graphql: *332 - search: *332 - code_search: *332 - source_import: *332 - integration_manifest: *332 - code_scanning_upload: *332 - actions_runner_registration: *332 - scim: *332 - dependency_snapshots: *332 - dependency_sbom: *332 - code_scanning_autofix: *332 + graphql: *334 + search: *334 + code_search: *334 + source_import: *334 + integration_manifest: *334 + code_scanning_upload: *334 + actions_runner_registration: *334 + scim: *334 + dependency_snapshots: *334 + dependency_sbom: *334 + code_scanning_autofix: *334 required: - core - search - rate: *332 + rate: *334 required: - rate - resources @@ -48132,14 +48026,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *333 + schema: *335 examples: default-response: summary: Default response @@ -48640,7 +48534,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *334 + '301': *336 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48658,8 +48552,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: false content: @@ -48906,10 +48800,10 @@ paths: description: Response content: application/json: - schema: *333 + schema: *335 examples: - default: *335 - '307': &336 + default: *337 + '307': &338 description: Temporary Redirect content: application/json: @@ -48938,8 +48832,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -48961,9 +48855,9 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *336 + '307': *338 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48985,11 +48879,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 - - &367 + - &371 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -49012,7 +48906,7 @@ paths: type: integer artifacts: type: array - items: &337 + items: &339 title: Artifact description: An artifact type: object @@ -49090,7 +48984,7 @@ paths: - expires_at - updated_at examples: - default: &368 + default: &372 value: total_count: 2 artifacts: @@ -49129,7 +49023,7 @@ paths: head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49151,9 +49045,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *327 - - *328 - - &338 + - *332 + - *333 + - &340 name: artifact_id description: The unique identifier of the artifact. in: path @@ -49165,7 +49059,7 @@ paths: description: Response content: application/json: - schema: *337 + schema: *339 examples: default: value: @@ -49203,9 +49097,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *327 - - *328 - - *338 + - *332 + - *333 + - *340 responses: '204': description: Response @@ -49229,9 +49123,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *327 - - *328 - - *338 + - *332 + - *333 + - *340 - name: archive_format in: path required: true @@ -49245,7 +49139,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': &523 + '410': &527 description: Gone content: application/json: @@ -49255,6 +49149,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: + - *332 + - *333 + responses: + '200': + description: Response + content: + application/json: + schema: &341 + 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 + example: 14 + examples: + default: *42 + '403': *29 + '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: + - *332 + - *333 + requestBody: + required: true + content: + application/json: + schema: *341 + examples: + selected_actions: *42 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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: + - *332 + - *333 + responses: + '200': + description: Response + content: + application/json: + schema: &342 + 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 + example: 10 + examples: + default: *44 + '403': *29 + '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: + - *332 + - *333 + requestBody: + required: true + content: + application/json: + schema: *342 + examples: + selected_actions: *44 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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 @@ -49272,14 +49316,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *339 + schema: *343 examples: default: value: @@ -49305,11 +49349,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 - - &340 + - &344 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 @@ -49337,13 +49381,13 @@ paths: - last_accessed_at - size_in_bytes default: last_accessed_at - - *48 + - *52 responses: '200': description: Response content: application/json: - schema: &341 + schema: &345 title: Repository actions caches description: Repository actions caches type: object @@ -49385,7 +49429,7 @@ paths: - total_count - actions_caches examples: - default: &342 + default: &346 value: total_count: 1 actions_caches: @@ -49397,7 +49441,7 @@ paths: created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49417,23 +49461,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: - - *327 - - *328 + - *332 + - *333 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *340 + - *344 responses: '200': description: Response content: application/json: - schema: *341 + schema: *345 examples: - default: *342 + default: *346 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49453,8 +49497,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: - - *327 - - *328 + - *332 + - *333 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -49485,9 +49529,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *327 - - *328 - - &343 + - *332 + - *333 + - &347 name: job_id description: The unique identifier of the job. in: path @@ -49499,7 +49543,7 @@ paths: description: Response content: application/json: - schema: &371 + schema: &375 title: Job description: Information of a job execution in a workflow run type: object @@ -49806,9 +49850,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *327 - - *328 - - *343 + - *332 + - *333 + - *347 responses: '302': description: Response @@ -49836,9 +49880,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *327 - - *328 - - *343 + - *332 + - *333 + - *347 requestBody: required: false content: @@ -49859,7 +49903,7 @@ paths: description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -49883,8 +49927,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: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Status response @@ -49934,8 +49978,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: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -49969,7 +50013,7 @@ paths: description: Empty response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -49998,8 +50042,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -50017,7 +50061,7 @@ paths: type: integer secrets: type: array - items: &373 + items: &377 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -50037,7 +50081,7 @@ paths: - created_at - updated_at examples: - default: &374 + default: &378 value: total_count: 2 secrets: @@ -50048,7 +50092,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50070,9 +50114,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *327 - - *328 - - *344 + - *332 + - *333 + - *348 - *19 responses: '200': @@ -50089,7 +50133,7 @@ paths: type: integer variables: type: array - items: &377 + items: &381 title: Actions Variable type: object properties: @@ -50119,7 +50163,7 @@ paths: - created_at - updated_at examples: - default: &378 + default: &382 value: total_count: 2 variables: @@ -50132,7 +50176,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50152,8 +50196,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -50162,12 +50206,12 @@ paths: schema: type: object properties: - enabled: &346 + enabled: &350 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *128 - selected_actions_url: *345 - sha_pinning_required: *129 + allowed_actions: *134 + selected_actions_url: *349 + sha_pinning_required: *135 required: - enabled examples: @@ -50195,8 +50239,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -50207,9 +50251,9 @@ paths: schema: type: object properties: - enabled: *346 - allowed_actions: *128 - sha_pinning_required: *129 + enabled: *350 + allowed_actions: *134 + sha_pinning_required: *135 required: - enabled examples: @@ -50239,14 +50283,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: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: &347 + schema: &351 type: object properties: access_level: @@ -50263,7 +50307,7 @@ paths: required: - access_level examples: - default: &348 + default: &352 value: access_level: organization x-github: @@ -50287,15 +50331,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: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: application/json: - schema: *347 + schema: *351 examples: - default: *348 + default: *352 responses: '204': description: Response @@ -50319,14 +50363,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *349 + schema: *353 examples: default: value: @@ -50350,8 +50394,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Empty response for successful settings update @@ -50361,7 +50405,7 @@ paths: required: true content: application/json: - schema: *350 + schema: *354 examples: default: summary: Set retention days @@ -50385,16 +50429,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *130 + schema: *136 examples: - default: *351 + default: *355 '404': *6 x-github: enabledForGitHubApps: true @@ -50413,8 +50457,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -50424,7 +50468,7 @@ paths: required: true content: application/json: - schema: *130 + schema: *136 examples: default: summary: Set approval policy to first time contributors @@ -50448,16 +50492,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: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *352 + schema: *356 examples: - default: *131 + default: *137 '403': *29 '404': *6 x-github: @@ -50477,15 +50521,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: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: application/json: - schema: *353 + schema: *357 examples: - default: *131 + default: *137 responses: '204': description: Empty response for successful settings update @@ -50509,16 +50553,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *133 + schema: *139 examples: - default: *134 + default: *140 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50537,8 +50581,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -50546,9 +50590,9 @@ paths: required: false content: application/json: - schema: *133 + schema: *139 examples: - selected_actions: *134 + selected_actions: *140 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50570,16 +50614,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *354 + schema: *358 examples: - default: *138 + default: *144 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50600,8 +50644,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Success response @@ -50612,9 +50656,9 @@ paths: required: true content: application/json: - schema: *355 + schema: *359 examples: - default: *138 + default: *144 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50641,8 +50685,8 @@ paths: in: query schema: type: string - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -50660,11 +50704,11 @@ paths: type: integer runners: type: array - items: *145 + items: *151 examples: - default: *146 + default: *152 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50686,8 +50730,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -50695,9 +50739,9 @@ paths: application/json: schema: type: array - items: *356 + items: *360 examples: - default: *357 + default: *361 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50719,8 +50763,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: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -50763,10 +50807,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *358 + '201': *362 '404': *6 '422': *7 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50794,16 +50838,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '201': description: Response content: application/json: - schema: *147 + schema: *153 examples: - default: *359 + default: *363 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50831,16 +50875,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '201': description: Response content: application/json: - schema: *147 + schema: *153 examples: - default: *360 + default: *364 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50862,17 +50906,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: - - *327 - - *328 - - *144 + - *332 + - *333 + - *150 responses: '200': description: Response content: application/json: - schema: *145 + schema: *151 examples: - default: *361 + default: *365 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50893,9 +50937,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: - - *327 - - *328 - - *144 + - *332 + - *333 + - *150 responses: '204': description: Response @@ -50921,11 +50965,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: - - *327 - - *328 - - *144 + - *332 + - *333 + - *150 responses: - '200': *149 + '200': *155 '404': *6 x-github: githubCloudOnly: false @@ -50947,9 +50991,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: - - *327 - - *328 - - *144 + - *332 + - *333 + - *150 requestBody: required: true content: @@ -50973,7 +51017,7 @@ paths: - gpu - accelerated responses: - '200': *149 + '200': *155 '404': *6 '422': *7 x-github: @@ -50997,9 +51041,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: - - *327 - - *328 - - *144 + - *332 + - *333 + - *150 requestBody: required: true content: @@ -51024,7 +51068,7 @@ paths: - gpu - accelerated responses: - '200': *149 + '200': *155 '404': *6 '422': *7 x-github: @@ -51048,11 +51092,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: - - *327 - - *328 - - *144 + - *332 + - *333 + - *150 responses: - '200': *362 + '200': *366 '404': *6 x-github: githubCloudOnly: false @@ -51079,12 +51123,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: - - *327 - - *328 - - *144 - - *363 + - *332 + - *333 + - *150 + - *367 responses: - '200': *149 + '200': *155 '404': *6 '422': *7 x-github: @@ -51110,9 +51154,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *327 - - *328 - - &381 + - *332 + - *333 + - &385 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. @@ -51120,7 +51164,7 @@ paths: required: false schema: type: string - - &382 + - &386 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -51128,7 +51172,7 @@ paths: required: false schema: type: string - - &383 + - &387 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -51137,7 +51181,7 @@ paths: required: false schema: type: string - - &384 + - &388 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 @@ -51164,7 +51208,7 @@ paths: - pending - *17 - *19 - - &385 + - &389 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)." @@ -51173,7 +51217,7 @@ paths: schema: type: string format: date-time - - &364 + - &368 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -51182,13 +51226,13 @@ paths: schema: type: boolean default: false - - &386 + - &390 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &387 + - &391 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -51211,7 +51255,7 @@ paths: type: integer workflow_runs: type: array - items: &365 + items: &369 title: Workflow Run description: An invocation of a workflow type: object @@ -51306,7 +51350,7 @@ paths: that triggered the run. type: array nullable: true - items: &406 + items: &410 title: Pull Request Minimal type: object properties: @@ -51425,7 +51469,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &410 + properties: &414 id: type: string description: SHA for the commit @@ -51476,7 +51520,7 @@ paths: - name - email nullable: true - required: &411 + required: &415 - id - tree_id - message @@ -51484,8 +51528,8 @@ paths: - author - committer nullable: true - repository: *143 - head_repository: *143 + repository: *149 + head_repository: *149 head_repository_id: type: integer example: 5 @@ -51523,7 +51567,7 @@ paths: - workflow_url - pull_requests examples: - default: &388 + default: &392 value: total_count: 1 workflow_runs: @@ -51737,7 +51781,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: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51759,24 +51803,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *327 - - *328 - - &366 + - *332 + - *333 + - &370 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *364 + - *368 responses: '200': description: Response content: application/json: - schema: *365 + schema: *369 examples: - default: &369 + default: &373 value: id: 30433642 name: Build @@ -52017,9 +52061,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 responses: '204': description: Response @@ -52042,9 +52086,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 responses: '200': description: Response @@ -52163,15 +52207,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: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 responses: '201': description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -52198,12 +52242,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 - *17 - *19 - - *367 + - *371 responses: '200': description: Response @@ -52219,11 +52263,11 @@ paths: type: integer artifacts: type: array - items: *337 + items: *339 examples: - default: *368 + default: *372 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52245,25 +52289,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *327 - - *328 - - *366 - - &370 + - *332 + - *333 + - *370 + - &374 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *364 + - *368 responses: '200': description: Response content: application/json: - schema: *365 + schema: *369 examples: - default: *369 + default: *373 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52286,10 +52330,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *327 - - *328 - - *366 + - *332 + - *333 - *370 + - *374 - *17 - *19 responses: @@ -52307,9 +52351,9 @@ paths: type: integer jobs: type: array - items: *371 + items: *375 examples: - default: &372 + default: &376 value: total_count: 1 jobs: @@ -52398,7 +52442,7 @@ paths: workflow_name: CI head_branch: main headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -52422,10 +52466,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *327 - - *328 - - *366 + - *332 + - *333 - *370 + - *374 responses: '302': description: Response @@ -52453,19 +52497,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 responses: '202': description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52488,9 +52532,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: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 requestBody: required: true content: @@ -52557,19 +52601,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 responses: '202': description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52592,9 +52636,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 - 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 @@ -52624,11 +52668,11 @@ paths: type: integer jobs: type: array - items: *371 + items: *375 examples: - default: *372 + default: *376 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52651,9 +52695,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 responses: '302': description: Response @@ -52680,14 +52724,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 responses: '204': description: Response '403': *29 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52709,9 +52753,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 responses: '200': description: Response @@ -52771,7 +52815,7 @@ paths: items: type: object properties: - type: &489 + type: &493 type: string description: The type of reviewer. enum: @@ -52781,7 +52825,7 @@ paths: reviewer: anyOf: - *4 - - *181 + - *187 required: - environment - wait_timer @@ -52856,9 +52900,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 requestBody: required: true content: @@ -52905,7 +52949,7 @@ paths: application/json: schema: type: array - items: &484 + items: &488 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -52993,8 +53037,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 required: - id - node_id @@ -53011,7 +53055,7 @@ paths: - created_at - updated_at examples: - default: &485 + default: &489 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -53067,9 +53111,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 requestBody: required: false content: @@ -53090,7 +53134,7 @@ paths: description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -53113,9 +53157,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 requestBody: required: false content: @@ -53136,7 +53180,7 @@ paths: description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -53168,9 +53212,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 responses: '200': description: Response @@ -53307,8 +53351,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -53326,11 +53370,11 @@ paths: type: integer secrets: type: array - items: *373 + items: *377 examples: - default: *374 + default: *378 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53353,16 +53397,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *375 + schema: *379 examples: - default: *376 + default: *380 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53384,17 +53428,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *327 - - *328 - - *151 + - *332 + - *333 + - *157 responses: '200': description: Response content: application/json: - schema: *373 + schema: *377 examples: - default: &502 + default: &506 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -53420,9 +53464,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 - - *151 + - *332 + - *333 + - *157 requestBody: required: true content: @@ -53453,7 +53497,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -53479,9 +53523,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *327 - - *328 - - *151 + - *332 + - *333 + - *157 responses: '204': description: Response @@ -53506,9 +53550,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *327 - - *328 - - *344 + - *332 + - *333 + - *348 - *19 responses: '200': @@ -53525,11 +53569,11 @@ paths: type: integer variables: type: array - items: *377 + items: *381 examples: - default: *378 + default: *382 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53550,8 +53594,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -53578,7 +53622,7 @@ paths: description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -53603,17 +53647,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *327 - - *328 - - *154 + - *332 + - *333 + - *160 responses: '200': description: Response content: application/json: - schema: *377 + schema: *381 examples: - default: &503 + default: &507 value: name: USERNAME value: octocat @@ -53639,9 +53683,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *327 - - *328 - - *154 + - *332 + - *333 + - *160 requestBody: required: true content: @@ -53683,9 +53727,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *327 - - *328 - - *154 + - *332 + - *333 + - *160 responses: '204': description: Response @@ -53710,8 +53754,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -53729,7 +53773,7 @@ paths: type: integer workflows: type: array - items: &379 + items: &383 title: Workflow description: A GitHub Actions workflow type: object @@ -53813,7 +53857,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: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53836,9 +53880,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *327 - - *328 - - &380 + - *332 + - *333 + - &384 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -53853,7 +53897,7 @@ paths: description: Response content: application/json: - schema: *379 + schema: *383 examples: default: value: @@ -53886,9 +53930,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *327 - - *328 - - *380 + - *332 + - *333 + - *384 responses: '204': description: Response @@ -53913,9 +53957,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *327 - - *328 - - *380 + - *332 + - *333 + - *384 responses: '204': description: Response @@ -53966,9 +54010,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *327 - - *328 - - *380 + - *332 + - *333 + - *384 responses: '204': description: Response @@ -53995,19 +54039,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *327 - - *328 - - *380 - - *381 - - *382 - - *383 + - *332 + - *333 - *384 - - *17 - - *19 - *385 - - *364 - *386 - *387 + - *388 + - *17 + - *19 + - *389 + - *368 + - *390 + - *391 responses: '200': description: Response @@ -54023,11 +54067,11 @@ paths: type: integer workflow_runs: type: array - items: *365 + items: *369 examples: - default: *388 + default: *392 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54057,9 +54101,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *327 - - *328 - - *380 + - *332 + - *333 + - *384 responses: '200': description: Response @@ -54120,12 +54164,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *327 - - *328 - - *48 + - *332 + - *333 + - *52 - *17 - - *40 - - *41 + - *45 + - *46 - name: ref description: |- The Git reference for the activities you want to list. @@ -54266,7 +54310,7 @@ paths: type: User site_admin: false headers: - Link: *54 + Link: *58 '422': *7 x-github: githubCloudOnly: false @@ -54285,8 +54329,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -54298,9 +54342,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -54323,8 +54367,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *327 - - *328 + - *332 + - *333 - name: assignee in: path required: true @@ -54360,8 +54404,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -54473,11 +54517,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: - - *327 - - *328 + - *332 + - *333 - *17 - - *40 - - *41 + - *45 + - *46 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -54531,7 +54575,7 @@ paths: initiator: type: string examples: - default: *389 + default: *393 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54551,8 +54595,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -54560,7 +54604,7 @@ paths: application/json: schema: type: array - items: &390 + items: &394 title: Autolink reference description: An autolink reference. type: object @@ -54614,8 +54658,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -54654,9 +54698,9 @@ paths: description: response content: application/json: - schema: *390 + schema: *394 examples: - default: &391 + default: &395 value: id: 1 key_prefix: TICKET- @@ -54687,9 +54731,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *327 - - *328 - - &392 + - *332 + - *333 + - &396 name: autolink_id description: The unique identifier of the autolink. in: path @@ -54701,9 +54745,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *394 examples: - default: *391 + default: *395 '404': *6 x-github: githubCloudOnly: false @@ -54723,9 +54767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *327 - - *328 - - *392 + - *332 + - *333 + - *396 responses: '204': description: Response @@ -54749,8 +54793,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: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response if Dependabot is enabled @@ -54798,8 +54842,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -54820,8 +54864,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -54841,8 +54885,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *327 - - *328 + - *332 + - *333 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -54880,7 +54924,7 @@ paths: - url protected: type: boolean - protection: &394 + protection: &398 title: Branch Protection description: Branch Protection type: object @@ -54922,7 +54966,7 @@ paths: required: - contexts - checks - enforce_admins: &397 + enforce_admins: &401 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -54937,7 +54981,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &399 + required_pull_request_reviews: &403 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -54958,7 +55002,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *181 + items: *187 apps: description: The list of apps with review dismissal access. @@ -54987,7 +55031,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *181 + items: *187 apps: description: The list of apps allowed to bypass pull request requirements. @@ -55013,7 +55057,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &396 + restrictions: &400 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -55076,7 +55120,7 @@ paths: type: string teams: type: array - items: *181 + items: *187 apps: type: array items: @@ -55272,7 +55316,7 @@ paths: - linter protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -55290,9 +55334,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *327 - - *328 - - &395 + - *332 + - *333 + - &399 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). @@ -55306,14 +55350,14 @@ paths: description: Response content: application/json: - schema: &405 + schema: &409 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &458 + commit: &462 title: Commit description: Commit type: object @@ -55347,7 +55391,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &393 + properties: &397 name: type: string example: '"Chris Wanstrath"' @@ -55356,13 +55400,14 @@ paths: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true committer: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *393 + properties: *397 nullable: true message: type: string @@ -55383,7 +55428,7 @@ paths: required: - sha - url - verification: &509 + verification: &513 title: Verification type: object properties: @@ -55417,12 +55462,12 @@ paths: nullable: true oneOf: - *4 - - *152 + - *158 committer: nullable: true oneOf: - *4 - - *152 + - *158 parents: type: array items: @@ -55453,7 +55498,7 @@ paths: type: integer files: type: array - items: &471 + items: &475 title: Diff Entry description: Diff Entry type: object @@ -55537,7 +55582,7 @@ paths: - self protected: type: boolean - protection: *394 + protection: *398 protection_url: type: string format: uri @@ -55644,7 +55689,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *334 + '301': *336 '404': *6 x-github: githubCloudOnly: false @@ -55666,15 +55711,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response content: application/json: - schema: *394 + schema: *398 examples: default: value: @@ -55868,9 +55913,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: true content: @@ -56125,7 +56170,7 @@ paths: url: type: string format: uri - required_status_checks: &402 + required_status_checks: &406 title: Status Check Policy description: Status Check Policy type: object @@ -56201,7 +56246,7 @@ paths: items: *4 teams: type: array - items: *181 + items: *187 apps: type: array items: *5 @@ -56219,7 +56264,7 @@ paths: items: *4 teams: type: array - items: *181 + items: *187 apps: type: array items: *5 @@ -56277,7 +56322,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *396 + restrictions: *400 required_conversation_resolution: type: object properties: @@ -56389,9 +56434,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '204': description: Response @@ -56416,17 +56461,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response content: application/json: - schema: *397 + schema: *401 examples: - default: &398 + default: &402 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -56448,17 +56493,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response content: application/json: - schema: *397 + schema: *401 examples: - default: *398 + default: *402 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56477,9 +56522,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '204': description: Response @@ -56504,17 +56549,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response content: application/json: - schema: *399 + schema: *403 examples: - default: &400 + default: &404 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -56610,9 +56655,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: false content: @@ -56710,9 +56755,9 @@ paths: description: Response content: application/json: - schema: *399 + schema: *403 examples: - default: *400 + default: *404 '422': *15 x-github: githubCloudOnly: false @@ -56733,9 +56778,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '204': description: Response @@ -56762,17 +56807,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response content: application/json: - schema: *397 + schema: *401 examples: - default: &401 + default: &405 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -56795,17 +56840,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response content: application/json: - schema: *397 + schema: *401 examples: - default: *401 + default: *405 '404': *6 x-github: githubCloudOnly: false @@ -56825,9 +56870,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '204': description: Response @@ -56852,17 +56897,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response content: application/json: - schema: *402 + schema: *406 examples: - default: &403 + default: &407 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -56888,9 +56933,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: false content: @@ -56942,9 +56987,9 @@ paths: description: Response content: application/json: - schema: *402 + schema: *406 examples: - default: *403 + default: *407 '404': *6 '422': *15 x-github: @@ -56966,9 +57011,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '204': description: Response @@ -56992,9 +57037,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response @@ -57028,9 +57073,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: false content: @@ -57097,9 +57142,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: false content: @@ -57163,9 +57208,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: content: application/json: @@ -57231,15 +57276,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response content: application/json: - schema: *396 + schema: *400 examples: default: value: @@ -57330,9 +57375,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '204': description: Response @@ -57355,9 +57400,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response @@ -57367,7 +57412,7 @@ paths: type: array items: *5 examples: - default: &404 + default: &408 value: - id: 1 slug: octoapp @@ -57424,9 +57469,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: true content: @@ -57460,7 +57505,7 @@ paths: type: array items: *5 examples: - default: *404 + default: *408 '422': *15 x-github: githubCloudOnly: false @@ -57481,9 +57526,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: true content: @@ -57517,7 +57562,7 @@ paths: type: array items: *5 examples: - default: *404 + default: *408 '422': *15 x-github: githubCloudOnly: false @@ -57538,9 +57583,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: true content: @@ -57574,7 +57619,7 @@ paths: type: array items: *5 examples: - default: *404 + default: *408 '422': *15 x-github: githubCloudOnly: false @@ -57596,9 +57641,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response @@ -57606,9 +57651,9 @@ paths: application/json: schema: type: array - items: *181 + items: *187 examples: - default: *236 + default: *242 '404': *6 x-github: githubCloudOnly: false @@ -57628,9 +57673,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: false content: @@ -57666,9 +57711,9 @@ paths: application/json: schema: type: array - items: *181 + items: *187 examples: - default: *236 + default: *242 '422': *15 x-github: githubCloudOnly: false @@ -57689,9 +57734,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: false content: @@ -57727,9 +57772,9 @@ paths: application/json: schema: type: array - items: *181 + items: *187 examples: - default: *236 + default: *242 '422': *15 x-github: githubCloudOnly: false @@ -57750,9 +57795,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: content: application/json: @@ -57787,9 +57832,9 @@ paths: application/json: schema: type: array - items: *181 + items: *187 examples: - default: *236 + default: *242 '422': *15 x-github: githubCloudOnly: false @@ -57811,9 +57856,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response @@ -57823,7 +57868,7 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 '404': *6 x-github: githubCloudOnly: false @@ -57847,9 +57892,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: true content: @@ -57882,7 +57927,7 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 '422': *15 x-github: githubCloudOnly: false @@ -57907,9 +57952,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: true content: @@ -57942,7 +57987,7 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 '422': *15 x-github: githubCloudOnly: false @@ -57967,9 +58012,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: true content: @@ -58002,7 +58047,7 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 '422': *15 x-github: githubCloudOnly: false @@ -58029,9 +58074,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: true content: @@ -58053,7 +58098,7 @@ paths: description: Response content: application/json: - schema: *405 + schema: *409 examples: default: value: @@ -58169,8 +58214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -58449,7 +58494,7 @@ paths: description: Response content: application/json: - schema: &407 + schema: &411 title: CheckRun description: A check performed on the code of a given code change type: object @@ -58560,16 +58605,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *406 - deployment: &714 + items: *410 + deployment: &725 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -58636,8 +58681,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 required: - id - node_id @@ -58849,9 +58894,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *327 - - *328 - - &408 + - *332 + - *333 + - &412 name: check_run_id description: The unique identifier of the check run. in: path @@ -58863,9 +58908,9 @@ paths: description: Response content: application/json: - schema: *407 + schema: *411 examples: - default: &409 + default: &413 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -58965,9 +59010,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *327 - - *328 - - *408 + - *332 + - *333 + - *412 requestBody: required: true content: @@ -59207,9 +59252,9 @@ paths: description: Response content: application/json: - schema: *407 + schema: *411 examples: - default: *409 + default: *413 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59229,9 +59274,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *327 - - *328 - - *408 + - *332 + - *333 + - *412 - *17 - *19 responses: @@ -59306,7 +59351,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: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59326,15 +59371,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *327 - - *328 - - *408 + - *332 + - *333 + - *412 responses: '201': description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -59372,8 +59417,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -59395,7 +59440,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &412 + schema: &416 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -59459,7 +59504,7 @@ paths: nullable: true pull_requests: type: array - items: *406 + items: *410 nullable: true app: title: GitHub app @@ -59470,9 +59515,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 - repository: *143 + properties: *71 + required: *72 + repository: *149 created_at: type: string format: date-time @@ -59481,12 +59526,12 @@ paths: type: string format: date-time nullable: true - head_commit: &740 + head_commit: &751 title: Simple Commit description: A commit. type: object - properties: *410 - required: *411 + properties: *414 + required: *415 latest_check_runs_count: type: integer check_runs_url: @@ -59514,7 +59559,7 @@ paths: - check_runs_url - pull_requests examples: - default: &413 + default: &417 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -59805,9 +59850,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *412 + schema: *416 examples: - default: *413 + default: *417 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59826,8 +59871,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -59888,7 +59933,7 @@ paths: required: - app_id - setting - repository: *143 + repository: *149 examples: default: value: @@ -60136,9 +60181,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *327 - - *328 - - &414 + - *332 + - *333 + - &418 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -60150,9 +60195,9 @@ paths: description: Response content: application/json: - schema: *412 + schema: *416 examples: - default: *413 + default: *417 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60175,17 +60220,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *327 - - *328 - - *414 - - &464 + - *332 + - *333 + - *418 + - &468 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &465 + - &469 name: status description: Returns check runs with the specified `status`. in: query @@ -60224,9 +60269,9 @@ paths: type: integer check_runs: type: array - items: *407 + items: *411 examples: - default: &466 + default: &470 value: total_count: 1 check_runs: @@ -60308,7 +60353,7 @@ paths: url: https://api.github.com/repos/github/hello-world name: hello-world headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60328,15 +60373,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *327 - - *328 - - *414 + - *332 + - *333 + - *418 responses: '201': description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -60363,30 +60408,30 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *327 - - *328 - - *415 - - *416 + - *332 + - *333 + - *419 + - *420 - *19 - *17 - - &433 + - &437 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: *417 - - &434 + schema: *421 + - &438 name: pr description: The number of the pull request for the results you want to list. in: query required: false schema: type: integer - - *48 - - *40 - - *41 + - *52 + - *45 + - *46 - name: sort description: The property by which to sort the results. in: query @@ -60402,13 +60447,13 @@ paths: be returned. in: query required: false - schema: *418 + schema: *422 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *419 + schema: *423 responses: '200': description: Response @@ -60419,14 +60464,14 @@ paths: items: type: object properties: - number: *161 - created_at: *162 - updated_at: *163 - url: *164 - html_url: *165 - instances_url: *420 - state: *170 - fixed_at: *166 + number: *167 + created_at: *168 + updated_at: *169 + url: *170 + html_url: *171 + instances_url: *424 + state: *176 + fixed_at: *172 dismissed_by: title: Simple User description: A GitHub user. @@ -60434,12 +60479,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *167 - dismissed_reason: *421 - dismissed_comment: *422 - rule: *423 - tool: *424 - most_recent_instance: *425 + dismissed_at: *173 + dismissed_reason: *425 + dismissed_comment: *426 + rule: *427 + tool: *428 + most_recent_instance: *429 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -60565,14 +60610,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &426 + '403': &430 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60592,9 +60637,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *327 - - *328 - - &427 + - *332 + - *333 + - &431 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -60602,23 +60647,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *161 + schema: *167 responses: '200': description: Response content: application/json: - schema: &428 + schema: &432 type: object properties: - number: *161 - created_at: *162 - updated_at: *163 - url: *164 - html_url: *165 - instances_url: *420 - state: *170 - fixed_at: *166 + number: *167 + created_at: *168 + updated_at: *169 + url: *170 + html_url: *171 + instances_url: *424 + state: *176 + fixed_at: *172 dismissed_by: title: Simple User description: A GitHub user. @@ -60626,9 +60671,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *167 - dismissed_reason: *421 - dismissed_comment: *422 + dismissed_at: *173 + dismissed_reason: *425 + dismissed_comment: *426 rule: type: object properties: @@ -60682,8 +60727,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *424 - most_recent_instance: *425 + tool: *428 + most_recent_instance: *429 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -60782,9 +60827,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *426 + '403': *430 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60802,9 +60847,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *327 - - *328 - - *427 + - *332 + - *333 + - *431 requestBody: required: true content: @@ -60819,8 +60864,8 @@ paths: enum: - open - dismissed - dismissed_reason: *421 - dismissed_comment: *422 + dismissed_reason: *425 + dismissed_comment: *426 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -60839,7 +60884,7 @@ paths: description: Response content: application/json: - schema: *428 + schema: *432 examples: default: value: @@ -60915,14 +60960,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &432 + '403': &436 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': *104 + '503': *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -60942,15 +60987,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: - - *327 - - *328 - - *427 + - *332 + - *333 + - *431 responses: '200': description: Response content: application/json: - schema: &429 + schema: &433 type: object properties: status: @@ -60976,13 +61021,13 @@ paths: - description - started_at examples: - default: &430 + default: &434 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &431 + '400': &435 description: Bad Request content: application/json: @@ -60993,9 +61038,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': *426 + '403': *430 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61018,29 +61063,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: - - *327 - - *328 - - *427 + - *332 + - *333 + - *431 responses: '200': description: OK content: application/json: - schema: *429 + schema: *433 examples: - default: *430 + default: *434 '202': description: Accepted content: application/json: - schema: *429 + schema: *433 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *431 + '400': *435 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -61050,7 +61095,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61072,9 +61117,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: - - *327 - - *328 - - *427 + - *332 + - *333 + - *431 requestBody: required: false content: @@ -61119,12 +61164,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *431 - '403': *432 + '400': *435 + '403': *436 '404': *6 '422': description: Unprocessable Entity - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61144,13 +61189,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *327 - - *328 - - *427 + - *332 + - *333 + - *431 - *19 - *17 - - *433 - - *434 + - *437 + - *438 responses: '200': description: Response @@ -61158,7 +61203,7 @@ paths: application/json: schema: type: array - items: *425 + items: *429 examples: default: value: @@ -61197,9 +61242,9 @@ paths: end_column: 50 classifications: - source - '403': *426 + '403': *430 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61231,29 +61276,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *327 - - *328 - - *415 - - *416 + - *332 + - *333 + - *419 + - *420 - *19 - *17 - - *434 + - *438 - 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: *417 + schema: *421 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &437 + schema: &441 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 - - *48 + - *52 - name: sort description: The property by which to sort the results. in: query @@ -61270,23 +61315,23 @@ paths: application/json: schema: type: array - items: &438 + items: &442 type: object properties: - ref: *417 - commit_sha: &446 + ref: *421 + commit_sha: &450 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: *435 + analysis_key: *439 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *436 + category: *440 error: type: string example: error reading field xyz @@ -61310,8 +61355,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *437 - tool: *424 + sarif_id: *441 + tool: *428 deletable: type: boolean warning: @@ -61372,9 +61417,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *426 + '403': *430 '404': *6 - '503': *104 + '503': *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -61408,8 +61453,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: - - *327 - - *328 + - *332 + - *333 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -61422,7 +61467,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *442 examples: response: summary: application/json response @@ -61476,14 +61521,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *426 + '403': *430 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *104 + '503': *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -61563,8 +61608,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: - - *327 - - *328 + - *332 + - *333 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -61617,9 +61662,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': *432 + '403': *436 '404': *6 - '503': *104 + '503': *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -61639,8 +61684,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -61648,7 +61693,7 @@ paths: application/json: schema: type: array - items: &439 + items: &443 title: CodeQL Database description: A CodeQL database. type: object @@ -61759,9 +61804,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': *426 + '403': *430 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61788,8 +61833,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 - name: language in: path description: The language of the CodeQL database. @@ -61801,7 +61846,7 @@ paths: description: Response content: application/json: - schema: *439 + schema: *443 examples: default: value: @@ -61833,11 +61878,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': &473 + '302': &477 description: Found - '403': *426 + '403': *430 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61857,8 +61902,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *327 - - *328 + - *332 + - *333 - name: language in: path description: The language of the CodeQL database. @@ -61868,9 +61913,9 @@ paths: responses: '204': description: Response - '403': *432 + '403': *436 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61896,8 +61941,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -61906,7 +61951,7 @@ paths: type: object additionalProperties: false properties: - language: &440 + language: &444 type: string description: The language targeted by the CodeQL query enum: @@ -61986,7 +62031,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &444 + schema: &448 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -61994,9 +62039,9 @@ paths: id: type: integer description: The ID of the variant analysis. - controller_repo: *53 + controller_repo: *57 actor: *4 - query_language: *440 + query_language: *444 query_pack_url: type: string description: The download url for the query pack. @@ -62043,7 +62088,7 @@ paths: items: type: object properties: - repository: &441 + repository: &445 title: Repository Identifier description: Repository Identifier type: object @@ -62079,7 +62124,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &445 + analysis_status: &449 type: string description: The new status of the CodeQL variant analysis repository task. @@ -62111,7 +62156,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &442 + access_mismatch_repos: &446 type: object properties: repository_count: @@ -62125,7 +62170,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: *441 + items: *445 required: - repository_count - repositories @@ -62147,8 +62192,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *442 - over_limit_repos: *442 + no_codeql_db_repos: *446 + over_limit_repos: *446 required: - access_mismatch_repos - not_found_repos @@ -62164,7 +62209,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &443 + value: &447 summary: Default response value: id: 1 @@ -62316,17 +62361,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *443 + value: *447 repository_lists: summary: Response for a successful variant analysis submission - value: *443 + value: *447 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62347,8 +62392,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: - - *327 - - *328 + - *332 + - *333 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -62360,11 +62405,11 @@ paths: description: Response content: application/json: - schema: *444 + schema: *448 examples: - default: *443 + default: *447 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62385,7 +62430,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: - - *327 + - *332 - name: repo in: path description: The name of the controller repository. @@ -62419,8 +62464,8 @@ paths: schema: type: object properties: - repository: *53 - analysis_status: *445 + repository: *57 + analysis_status: *449 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -62524,7 +62569,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62545,8 +62590,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -62631,9 +62676,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *426 + '403': *430 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62652,8 +62697,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -62720,7 +62765,7 @@ paths: description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -62745,7 +62790,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *432 + '403': *436 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -62759,7 +62804,7 @@ paths: content: application/json: schema: *3 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62816,8 +62861,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -62825,7 +62870,7 @@ paths: schema: type: object properties: - commit_sha: *446 + commit_sha: *450 ref: type: string description: |- @@ -62883,7 +62928,7 @@ paths: schema: type: object properties: - id: *437 + id: *441 url: type: string description: The REST API URL for checking the status of the upload. @@ -62897,11 +62942,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': *432 + '403': *436 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *104 + '503': *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -62920,8 +62965,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *327 - - *328 + - *332 + - *333 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -62967,10 +63012,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': *426 + '403': *430 '404': description: Not Found if the sarif id does not match any upload - '503': *104 + '503': *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -62992,8 +63037,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: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -63017,7 +63062,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *43 + configuration: *47 examples: default: value: @@ -63049,7 +63094,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': *175 + '204': *181 '304': *37 '403': *29 '404': *6 @@ -63074,8 +63119,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *327 - - *328 + - *332 + - *333 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -63195,8 +63240,8 @@ paths: parameters: - *17 - *19 - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -63212,7 +63257,7 @@ paths: type: integer codespaces: type: array - items: *224 + items: *230 examples: default: value: @@ -63488,7 +63533,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': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -63510,8 +63555,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -63574,22 +63619,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *224 + schema: *230 examples: - default: *447 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *224 + schema: *230 examples: - default: *447 + default: *451 '400': *14 '401': *25 '403': *29 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63613,8 +63658,8 @@ paths: parameters: - *17 - *19 - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -63654,7 +63699,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *103 + '500': *109 '400': *14 '401': *25 '403': *29 @@ -63678,8 +63723,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -63714,14 +63759,14 @@ paths: type: integer machines: type: array - items: &669 + items: &671 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *448 - required: *449 + properties: *452 + required: *453 examples: - default: &670 + default: &672 value: total_count: 2 machines: @@ -63738,7 +63783,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *37 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -63761,8 +63806,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *327 - - *328 + - *332 + - *333 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -63846,8 +63891,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: - - *327 - - *328 + - *332 + - *333 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -63892,7 +63937,7 @@ paths: '403': *29 '404': *6 '422': *15 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63913,8 +63958,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -63932,7 +63977,7 @@ paths: type: integer secrets: type: array - items: &453 + items: &457 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -63952,9 +63997,9 @@ paths: - created_at - updated_at examples: - default: *450 + default: *454 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63975,16 +64020,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *451 + schema: *455 examples: - default: *452 + default: *456 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64004,17 +64049,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *327 - - *328 - - *151 + - *332 + - *333 + - *157 responses: '200': description: Response content: application/json: - schema: *453 + schema: *457 examples: - default: *454 + default: *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64034,9 +64079,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 - - *151 + - *332 + - *333 + - *157 requestBody: required: true content: @@ -64064,7 +64109,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -64088,9 +64133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *327 - - *328 - - *151 + - *332 + - *333 + - *157 responses: '204': description: Response @@ -64118,8 +64163,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *327 - - *328 + - *332 + - *333 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -64161,7 +64206,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &455 + properties: &459 login: type: string example: octocat @@ -64254,7 +64299,7 @@ paths: user_view_type: type: string example: public - required: &456 + required: &460 - avatar_url - events_url - followers_url @@ -64303,7 +64348,7 @@ paths: admin: false role_name: write headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -64328,9 +64373,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *327 - - *328 - - *59 + - *332 + - *333 + - *63 responses: '204': description: Response if user is a collaborator @@ -64376,9 +64421,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *327 - - *328 - - *59 + - *332 + - *333 + - *63 requestBody: required: false content: @@ -64404,7 +64449,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &522 + schema: &526 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -64415,7 +64460,7 @@ paths: example: 42 type: integer format: int64 - repository: *143 + repository: *149 invitee: title: Simple User description: A GitHub user. @@ -64593,7 +64638,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *112 + schema: *118 '403': *29 x-github: triggersNotification: true @@ -64633,9 +64678,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *327 - - *328 - - *59 + - *332 + - *333 + - *63 responses: '204': description: No Content when collaborator was removed from the repository. @@ -64666,9 +64711,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *327 - - *328 - - *59 + - *332 + - *333 + - *63 responses: '200': description: if user has admin permissions @@ -64688,8 +64733,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *455 - required: *456 + properties: *459 + required: *460 nullable: true required: - permission @@ -64744,8 +64789,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -64755,7 +64800,7 @@ paths: application/json: schema: type: array - items: &457 + items: &461 title: Commit Comment description: Commit Comment type: object @@ -64796,8 +64841,8 @@ paths: updated_at: type: string format: date-time - author_association: *69 - reactions: *70 + author_association: *73 + reactions: *74 required: - url - html_url @@ -64813,7 +64858,7 @@ paths: - created_at - updated_at examples: - default: &460 + default: &464 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -64847,7 +64892,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' author_association: COLLABORATOR headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64872,17 +64917,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 responses: '200': description: Response content: application/json: - schema: *457 + schema: *461 examples: - default: &461 + default: &465 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -64939,9 +64984,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 requestBody: required: true content: @@ -64963,7 +65008,7 @@ paths: description: Response content: application/json: - schema: *457 + schema: *461 examples: default: value: @@ -65014,9 +65059,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 responses: '204': description: Response @@ -65037,9 +65082,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. @@ -65065,11 +65110,11 @@ paths: application/json: schema: type: array - items: *320 + items: *327 examples: - default: *322 + default: *329 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -65088,9 +65133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 requestBody: required: true content: @@ -65122,16 +65167,16 @@ paths: description: Reaction exists content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '201': description: Reaction created content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '422': *15 x-github: githubCloudOnly: false @@ -65153,10 +65198,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *327 - - *328 - - *81 - - *323 + - *332 + - *333 + - *85 + - *330 responses: '204': description: Response @@ -65205,8 +65250,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *327 - - *328 + - *332 + - *333 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -65262,9 +65307,9 @@ paths: application/json: schema: type: array - items: *458 + items: *462 examples: - default: &575 + default: &579 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -65334,11 +65379,11 @@ paths: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: - Link: *54 - '500': *103 + Link: *58 + '500': *109 '400': *14 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65358,9 +65403,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *327 - - *328 - - &459 + - *332 + - *333 + - &463 name: commit_sha description: The SHA of the commit. in: path @@ -65407,7 +65452,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65432,9 +65477,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *327 - - *328 - - *459 + - *332 + - *333 + - *463 - *17 - *19 responses: @@ -65444,11 +65489,11 @@ paths: application/json: schema: type: array - items: *457 + items: *461 examples: - default: *460 + default: *464 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65474,9 +65519,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *327 - - *328 - - *459 + - *332 + - *333 + - *463 requestBody: required: true content: @@ -65511,9 +65556,9 @@ paths: description: Response content: application/json: - schema: *457 + schema: *461 examples: - default: *461 + default: *465 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -65541,9 +65586,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *327 - - *328 - - *459 + - *332 + - *333 + - *463 - *17 - *19 responses: @@ -65553,9 +65598,9 @@ paths: application/json: schema: type: array - items: *462 + items: *466 examples: - default: &567 + default: &571 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -66034,8 +66079,8 @@ paths: auto_merge: draft: false headers: - Link: *54 - '409': *47 + Link: *58 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66092,11 +66137,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *327 - - *328 + - *332 + - *333 - *19 - *17 - - &463 + - &467 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -66111,9 +66156,9 @@ paths: description: Response content: application/json: - schema: *458 + schema: *462 examples: - default: &552 + default: &556 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -66199,9 +66244,9 @@ paths: ..... '422': *15 '404': *6 - '500': *103 - '503': *104 - '409': *47 + '500': *109 + '503': *110 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66226,11 +66271,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *327 - - *328 - - *463 - - *464 - - *465 + - *332 + - *333 + - *467 + - *468 + - *469 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -66264,11 +66309,11 @@ paths: type: integer check_runs: type: array - items: *407 + items: *411 examples: - default: *466 + default: *470 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66291,9 +66336,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *327 - - *328 - - *463 + - *332 + - *333 + - *467 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -66301,7 +66346,7 @@ paths: schema: type: integer example: 1 - - *464 + - *468 - *17 - *19 responses: @@ -66319,7 +66364,7 @@ paths: type: integer check_suites: type: array - items: *412 + items: *416 examples: default: value: @@ -66494,7 +66539,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: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66519,9 +66564,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *327 - - *328 - - *463 + - *332 + - *333 + - *467 - *17 - *19 responses: @@ -66588,7 +66633,7 @@ paths: type: string total_count: type: integer - repository: *143 + repository: *149 commit_url: type: string format: uri @@ -66719,9 +66764,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *327 - - *328 - - *463 + - *332 + - *333 + - *467 - *17 - *19 responses: @@ -66731,7 +66776,7 @@ paths: application/json: schema: type: array - items: &640 + items: &644 title: Status description: The status of a commit. type: object @@ -66811,8 +66856,8 @@ paths: type: User site_admin: false headers: - Link: *54 - '301': *334 + Link: *58 + '301': *336 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66840,8 +66885,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -66870,20 +66915,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *467 - required: *468 + properties: *471 + required: *472 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &469 + properties: &473 url: type: string format: uri html_url: type: string format: uri - required: &470 + required: &474 - url - html_url nullable: true @@ -66891,32 +66936,32 @@ paths: title: License Simple description: License Simple type: object - properties: *83 - required: *84 + properties: *87 + required: *88 nullable: true contributing: title: Community Health File type: object - properties: *469 - required: *470 + properties: *473 + required: *474 nullable: true readme: title: Community Health File type: object - properties: *469 - required: *470 + properties: *473 + required: *474 nullable: true issue_template: title: Community Health File type: object - properties: *469 - required: *470 + properties: *473 + required: *474 nullable: true pull_request_template: title: Community Health File type: object - properties: *469 - required: *470 + properties: *473 + required: *474 nullable: true required: - code_of_conduct @@ -67043,8 +67088,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *327 - - *328 + - *332 + - *333 - *19 - *17 - name: basehead @@ -67087,8 +67132,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *458 - merge_base_commit: *458 + base_commit: *462 + merge_base_commit: *462 status: type: string enum: @@ -67108,10 +67153,10 @@ paths: example: 6 commits: type: array - items: *458 + items: *462 files: type: array - items: *471 + items: *475 required: - url - html_url @@ -67354,8 +67399,8 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *6 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67397,8 +67442,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *327 - - *328 + - *332 + - *333 - name: path description: path parameter in: path @@ -67541,7 +67586,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &472 + response-if-content-is-a-file: &476 summary: Response if content is a file value: type: file @@ -67673,7 +67718,7 @@ paths: - size - type - url - - &580 + - &584 title: Content File description: Content File type: object @@ -67874,7 +67919,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *472 + response-if-content-is-a-file: *476 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -67943,7 +67988,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *473 + '302': *477 '304': *37 x-github: githubCloudOnly: false @@ -67966,8 +68011,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *327 - - *328 + - *332 + - *333 - name: path description: path parameter in: path @@ -68060,7 +68105,7 @@ paths: description: Response content: application/json: - schema: &474 + schema: &478 title: File Commit description: File Commit type: object @@ -68212,7 +68257,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *478 examples: example-for-creating-a-file: value: @@ -68266,7 +68311,7 @@ paths: schema: oneOf: - *3 - - &504 + - &508 description: Repository rule violation was detected type: object properties: @@ -68287,7 +68332,7 @@ paths: items: type: object properties: - placeholder_id: &632 + placeholder_id: &636 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -68319,8 +68364,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *327 - - *328 + - *332 + - *333 - name: path description: path parameter in: path @@ -68381,7 +68426,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *478 examples: default: value: @@ -68415,8 +68460,8 @@ paths: verified_at: '422': *15 '404': *6 - '409': *47 - '503': *104 + '409': *51 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68436,8 +68481,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *327 - - *328 + - *332 + - *333 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -68537,7 +68582,7 @@ paths: site_admin: false contributions: 32 headers: - Link: *54 + Link: *58 '204': description: Response if repository is empty '403': *29 @@ -68560,23 +68605,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *327 - - *328 - - *182 - - *183 - - *184 - - *185 + - *332 + - *333 + - *188 + - *189 + - *190 + - *191 - 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 - - *186 - - *475 - - *187 - - *188 - - *48 + - *192 + - *479 + - *193 + - *194 + - *52 - 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)." @@ -68585,8 +68630,8 @@ paths: schema: type: integer default: 30 - - *40 - - *41 + - *45 + - *46 responses: '200': description: Response @@ -68594,11 +68639,11 @@ paths: application/json: schema: type: array - items: &478 + items: &482 type: object description: A Dependabot alert. properties: - number: *161 + number: *167 state: type: string description: The state of the Dependabot alert. @@ -68613,7 +68658,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: *49 + package: *53 manifest_path: type: string description: The full path to the dependency manifest file, @@ -68640,13 +68685,13 @@ paths: - unknown - direct - transitive - security_advisory: *476 - security_vulnerability: *52 - url: *164 - html_url: *165 - created_at: *162 - updated_at: *163 - dismissed_at: *167 + security_advisory: *480 + security_vulnerability: *56 + url: *170 + html_url: *171 + created_at: *168 + updated_at: *169 + dismissed_at: *173 dismissed_by: title: Simple User description: A GitHub user. @@ -68670,8 +68715,8 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *166 - auto_dismissed_at: *477 + fixed_at: *172 + auto_dismissed_at: *481 required: - number - state @@ -68901,9 +68946,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *327 - - *328 - - &479 + - *332 + - *333 + - &483 name: alert_number in: path description: |- @@ -68912,13 +68957,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *161 + schema: *167 responses: '200': description: Response content: application/json: - schema: *478 + schema: *482 examples: default: value: @@ -69031,9 +69076,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *327 - - *328 - - *479 + - *332 + - *333 + - *483 requestBody: required: true content: @@ -69078,7 +69123,7 @@ paths: description: Response content: application/json: - schema: *478 + schema: *482 examples: default: value: @@ -69184,7 +69229,7 @@ paths: '400': *14 '403': *29 '404': *6 - '409': *47 + '409': *51 '422': *7 x-github: githubCloudOnly: false @@ -69207,8 +69252,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -69226,7 +69271,7 @@ paths: type: integer secrets: type: array - items: &482 + items: &486 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -69257,7 +69302,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69279,16 +69324,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *480 + schema: *484 examples: - default: *481 + default: *485 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69308,15 +69353,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *327 - - *328 - - *151 + - *332 + - *333 + - *157 responses: '200': description: Response content: application/json: - schema: *482 + schema: *486 examples: default: value: @@ -69342,9 +69387,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 - - *151 + - *332 + - *333 + - *157 requestBody: required: true content: @@ -69372,7 +69417,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -69396,9 +69441,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *327 - - *328 - - *151 + - *332 + - *333 + - *157 responses: '204': description: Response @@ -69420,8 +69465,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: - - *327 - - *328 + - *332 + - *333 - 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 @@ -69557,7 +69602,7 @@ paths: advisory_summary: Ruby OpenID advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 headers: - Link: *54 + Link: *58 '404': *6 '403': description: Response for a private repository when GitHub Advanced Security @@ -69581,8 +69626,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: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -69798,7 +69843,7 @@ paths: spdxElementId: SPDXRef-DOCUMENT relatedSpdxElement: SPDXRef-Repository headers: - Link: *54 + Link: *58 '404': *6 '403': *29 x-github: @@ -69821,8 +69866,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: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -69897,7 +69942,7 @@ paths: - version - url additionalProperties: false - metadata: &483 + metadata: &487 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -69930,7 +69975,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *483 + metadata: *487 resolved: type: object description: A collection of resolved package dependencies. @@ -69943,7 +69988,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *483 + metadata: *487 relationship: type: string description: A notation of whether a dependency is requested @@ -70072,8 +70117,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *327 - - *328 + - *332 + - *333 - name: sha description: The SHA recorded at creation time. in: query @@ -70113,11 +70158,11 @@ paths: application/json: schema: type: array - items: *484 + items: *488 examples: - default: *485 + default: *489 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70181,8 +70226,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -70263,7 +70308,7 @@ paths: description: Response content: application/json: - schema: *484 + schema: *488 examples: simple-example: summary: Simple example @@ -70336,9 +70381,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *327 - - *328 - - &486 + - *332 + - *333 + - &490 name: deployment_id description: deployment_id parameter in: path @@ -70350,7 +70395,7 @@ paths: description: Response content: application/json: - schema: *484 + schema: *488 examples: default: value: @@ -70415,9 +70460,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *327 - - *328 - - *486 + - *332 + - *333 + - *490 responses: '204': description: Response @@ -70439,9 +70484,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *327 - - *328 - - *486 + - *332 + - *333 + - *490 - *17 - *19 responses: @@ -70451,7 +70496,7 @@ paths: application/json: schema: type: array - items: &487 + items: &491 title: Deployment Status description: The status of a deployment. type: object @@ -70542,8 +70587,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 required: - id - node_id @@ -70592,7 +70637,7 @@ paths: environment_url: https://test-branch.lab.acme.com log_url: https://example.com/deployment/42/output headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -70612,9 +70657,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *327 - - *328 - - *486 + - *332 + - *333 + - *490 requestBody: required: true content: @@ -70689,9 +70734,9 @@ paths: description: Response content: application/json: - schema: *487 + schema: *491 examples: - default: &488 + default: &492 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -70747,9 +70792,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *327 - - *328 - - *486 + - *332 + - *333 + - *490 - name: status_id in: path required: true @@ -70760,9 +70805,9 @@ paths: description: Response content: application/json: - schema: *487 + schema: *491 examples: - default: *488 + default: *492 '404': *6 x-github: githubCloudOnly: false @@ -70787,8 +70832,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -70845,8 +70890,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -70863,7 +70908,7 @@ paths: type: integer environments: type: array - items: &490 + items: &494 title: Environment description: Details of a deployment environment type: object @@ -70915,7 +70960,7 @@ paths: type: type: string example: wait_timer - wait_timer: &492 + wait_timer: &496 type: integer example: 30 description: The amount of time to delay a job after @@ -70952,11 +70997,11 @@ paths: items: type: object properties: - type: *489 + type: *493 reviewer: anyOf: - *4 - - *181 + - *187 required: - id - node_id @@ -70976,7 +71021,7 @@ paths: - id - node_id - type - deployment_branch_policy: &493 + deployment_branch_policy: &497 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -71092,9 +71137,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *327 - - *328 - - &491 + - *332 + - *333 + - &495 name: environment_name in: path required: true @@ -71107,9 +71152,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *494 examples: - default: &494 + default: &498 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -71193,9 +71238,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *327 - - *328 - - *491 + - *332 + - *333 + - *495 requestBody: required: false content: @@ -71204,7 +71249,7 @@ paths: type: object nullable: true properties: - wait_timer: *492 + wait_timer: *496 prevent_self_review: type: boolean example: false @@ -71221,13 +71266,13 @@ paths: items: type: object properties: - type: *489 + type: *493 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *493 + deployment_branch_policy: *497 additionalProperties: false examples: default: @@ -71247,9 +71292,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *494 examples: - default: *494 + default: *498 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -71273,9 +71318,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *327 - - *328 - - *491 + - *332 + - *333 + - *495 responses: '204': description: Default response @@ -71300,9 +71345,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *327 - - *328 - - *491 + - *332 + - *333 + - *495 - *17 - *19 responses: @@ -71320,7 +71365,7 @@ paths: example: 2 branch_policies: type: array - items: &495 + items: &499 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -71377,9 +71422,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *327 - - *328 - - *491 + - *332 + - *333 + - *495 requestBody: required: true content: @@ -71425,9 +71470,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *499 examples: - example-wildcard: &496 + example-wildcard: &500 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -71469,10 +71514,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *327 - - *328 - - *491 - - &497 + - *332 + - *333 + - *495 + - &501 name: branch_policy_id in: path required: true @@ -71484,9 +71529,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *499 examples: - default: *496 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71505,10 +71550,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *327 - - *328 - - *491 - - *497 + - *332 + - *333 + - *495 + - *501 requestBody: required: true content: @@ -71536,9 +71581,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *499 examples: - default: *496 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71557,10 +71602,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *327 - - *328 - - *491 - - *497 + - *332 + - *333 + - *495 + - *501 responses: '204': description: Response @@ -71585,9 +71630,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *491 - - *328 - - *327 + - *495 + - *333 + - *332 responses: '200': description: List of deployment protection rules @@ -71603,7 +71648,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &498 + items: &502 title: Deployment protection rule description: Deployment protection rule type: object @@ -71622,7 +71667,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &499 + app: &503 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -71721,9 +71766,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: - - *491 - - *328 - - *327 + - *495 + - *333 + - *332 requestBody: content: application/json: @@ -71744,9 +71789,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *498 + schema: *502 examples: - default: &500 + default: &504 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -71781,9 +71826,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: - - *491 - - *328 - - *327 + - *495 + - *333 + - *332 - *19 - *17 responses: @@ -71802,7 +71847,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *499 + items: *503 examples: default: value: @@ -71837,10 +71882,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *327 - - *328 - - *491 - - &501 + - *332 + - *333 + - *495 + - &505 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -71852,9 +71897,9 @@ paths: description: Response content: application/json: - schema: *498 + schema: *502 examples: - default: *500 + default: *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71875,10 +71920,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *491 - - *328 - - *327 - - *501 + - *495 + - *333 + - *332 + - *505 responses: '204': description: Response @@ -71904,9 +71949,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *327 - - *328 - - *491 + - *332 + - *333 + - *495 - *17 - *19 responses: @@ -71924,11 +71969,11 @@ paths: type: integer secrets: type: array - items: *373 + items: *377 examples: - default: *374 + default: *378 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71951,17 +71996,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *327 - - *328 - - *491 + - *332 + - *333 + - *495 responses: '200': description: Response content: application/json: - schema: *375 + schema: *379 examples: - default: *376 + default: *380 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71983,18 +72028,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *327 - - *328 - - *491 - - *151 + - *332 + - *333 + - *495 + - *157 responses: '200': description: Response content: application/json: - schema: *373 + schema: *377 examples: - default: *502 + default: *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72016,10 +72061,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *327 - - *328 - - *491 - - *151 + - *332 + - *333 + - *495 + - *157 requestBody: required: true content: @@ -72050,7 +72095,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -72076,10 +72121,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *327 - - *328 - - *491 - - *151 + - *332 + - *333 + - *495 + - *157 responses: '204': description: Default response @@ -72104,10 +72149,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *327 - - *328 - - *491 - - *344 + - *332 + - *333 + - *495 + - *348 - *19 responses: '200': @@ -72124,11 +72169,11 @@ paths: type: integer variables: type: array - items: *377 + items: *381 examples: - default: *378 + default: *382 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72149,9 +72194,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *327 - - *328 - - *491 + - *332 + - *333 + - *495 requestBody: required: true content: @@ -72178,7 +72223,7 @@ paths: description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -72203,18 +72248,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *327 - - *328 - - *491 - - *154 + - *332 + - *333 + - *495 + - *160 responses: '200': description: Response content: application/json: - schema: *377 + schema: *381 examples: - default: *503 + default: *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72235,10 +72280,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *327 - - *328 - - *154 - - *491 + - *332 + - *333 + - *160 + - *495 requestBody: required: true content: @@ -72280,10 +72325,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *327 - - *328 - - *154 - - *491 + - *332 + - *333 + - *160 + - *495 responses: '204': description: Response @@ -72305,8 +72350,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -72316,7 +72361,7 @@ paths: application/json: schema: type: array - items: *94 + items: *98 examples: 200-response: value: @@ -72374,8 +72419,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *327 - - *328 + - *332 + - *333 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -72397,7 +72442,7 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: default: value: @@ -72510,7 +72555,7 @@ paths: url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== headers: - Link: *54 + Link: *58 '400': *14 x-github: githubCloudOnly: false @@ -72534,8 +72579,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: false content: @@ -72567,9 +72612,9 @@ paths: description: Response content: application/json: - schema: *333 + schema: *335 examples: - default: *335 + default: *337 '400': *14 '422': *15 '403': *29 @@ -72590,8 +72635,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -72642,7 +72687,7 @@ paths: schema: type: string '404': *6 - '409': *47 + '409': *51 '403': *29 '422': description: Validation failed @@ -72650,8 +72695,8 @@ paths: application/json: schema: oneOf: - - *112 - - *504 + - *118 + - *508 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72676,8 +72721,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *327 - - *328 + - *332 + - *333 - name: file_sha in: path required: true @@ -72728,7 +72773,7 @@ paths: '404': *6 '422': *15 '403': *29 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72776,8 +72821,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -72886,7 +72931,7 @@ paths: description: Response content: application/json: - schema: &505 + schema: &509 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -73050,7 +73095,7 @@ paths: type: string '422': *15 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73100,15 +73145,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *327 - - *328 - - *459 + - *332 + - *333 + - *463 responses: '200': description: Response content: application/json: - schema: *505 + schema: *509 examples: default: value: @@ -73139,7 +73184,7 @@ paths: payload: verified_at: '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73164,9 +73209,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *327 - - *328 - - &506 + - *332 + - *333 + - &510 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. @@ -73183,7 +73228,7 @@ paths: application/json: schema: type: array - items: &507 + items: &511 title: Git Reference description: Git references within a repository type: object @@ -73236,8 +73281,8 @@ paths: sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: - Link: *54 - '409': *47 + Link: *58 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73258,17 +73303,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *327 - - *328 - - *506 + - *332 + - *333 + - *510 responses: '200': description: Response content: application/json: - schema: *507 + schema: *511 examples: - default: &508 + default: &512 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -73278,7 +73323,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73297,8 +73342,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -73327,16 +73372,16 @@ paths: description: Response content: application/json: - schema: *507 + schema: *511 examples: - default: *508 + default: *512 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73355,9 +73400,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *327 - - *328 - - *506 + - *332 + - *333 + - *510 requestBody: required: true content: @@ -73386,11 +73431,11 @@ paths: description: Response content: application/json: - schema: *507 + schema: *511 examples: - default: *508 + default: *512 '422': *15 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73406,16 +73451,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *327 - - *328 - - *506 + - *332 + - *333 + - *510 responses: '204': description: Response '422': description: Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73463,8 +73508,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -73531,7 +73576,7 @@ paths: description: Response content: application/json: - schema: &510 + schema: &514 title: Git Tag description: Metadata for a Git tag type: object @@ -73582,7 +73627,7 @@ paths: - sha - type - url - verification: *509 + verification: *513 required: - sha - url @@ -73592,7 +73637,7 @@ paths: - tag - message examples: - default: &511 + default: &515 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -73619,7 +73664,7 @@ paths: schema: type: string '422': *15 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73665,8 +73710,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *327 - - *328 + - *332 + - *333 - name: tag_sha in: path required: true @@ -73677,11 +73722,11 @@ paths: description: Response content: application/json: - schema: *510 + schema: *514 examples: - default: *511 + default: *515 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73703,8 +73748,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -73777,7 +73822,7 @@ paths: description: Response content: application/json: - schema: &512 + schema: &516 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -73850,7 +73895,7 @@ paths: '422': *15 '404': *6 '403': *29 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73873,8 +73918,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *327 - - *328 + - *332 + - *333 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -73897,7 +73942,7 @@ paths: description: Response content: application/json: - schema: *512 + schema: *516 examples: default-response: summary: Default response @@ -73938,7 +73983,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73956,8 +74001,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -73967,7 +74012,7 @@ paths: application/json: schema: type: array - items: &513 + items: &517 title: Webhook description: Webhooks for repositories. type: object @@ -74021,7 +74066,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &748 + last_response: &759 title: Hook Response type: object properties: @@ -74076,7 +74121,7 @@ paths: status: unused message: headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -74095,8 +74140,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: false content: @@ -74148,9 +74193,9 @@ paths: description: Response content: application/json: - schema: *513 + schema: *517 examples: - default: &514 + default: &518 value: type: Repository id: 12345678 @@ -74198,17 +74243,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 responses: '200': description: Response content: application/json: - schema: *513 + schema: *517 examples: - default: *514 + default: *518 '404': *6 x-github: githubCloudOnly: false @@ -74228,9 +74273,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 requestBody: required: true content: @@ -74275,9 +74320,9 @@ paths: description: Response content: application/json: - schema: *513 + schema: *517 examples: - default: *514 + default: *518 '422': *15 '404': *6 x-github: @@ -74298,9 +74343,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 responses: '204': description: Response @@ -74324,9 +74369,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 responses: '200': description: Response @@ -74353,9 +74398,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 requestBody: required: false content: @@ -74399,11 +74444,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 - *17 - - *197 + - *203 responses: '200': description: Response @@ -74411,9 +74456,9 @@ paths: application/json: schema: type: array - items: *198 + items: *204 examples: - default: *199 + default: *205 '400': *14 '422': *15 x-github: @@ -74432,18 +74477,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 - *16 responses: '200': description: Response content: application/json: - schema: *200 + schema: *206 examples: - default: *201 + default: *207 '400': *14 '422': *15 x-github: @@ -74462,9 +74507,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 - *16 responses: '202': *39 @@ -74487,9 +74532,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 responses: '204': description: Response @@ -74514,9 +74559,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 responses: '204': description: Response @@ -74539,8 +74584,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response if immutable releases are enabled @@ -74586,11 +74631,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *327 - - *328 + - *332 + - *333 responses: - '204': *175 - '409': *47 + '204': *181 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74607,11 +74652,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *327 - - *328 + - *332 + - *333 responses: - '204': *175 - '409': *47 + '204': *181 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74665,14 +74710,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: &515 + schema: &519 title: Import description: A repository import from an external source. type: object @@ -74771,7 +74816,7 @@ paths: - html_url - authors_url examples: - default: &518 + default: &522 value: vcs: subversion use_lfs: true @@ -74787,7 +74832,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': &516 + '503': &520 description: Unavailable due to service under maintenance. content: application/json: @@ -74816,8 +74861,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -74865,7 +74910,7 @@ paths: description: Response content: application/json: - schema: *515 + schema: *519 examples: default: value: @@ -74890,7 +74935,7 @@ paths: type: string '422': *15 '404': *6 - '503': *516 + '503': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74918,8 +74963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: false content: @@ -74968,7 +75013,7 @@ paths: description: Response content: application/json: - schema: *515 + schema: *519 examples: example-1: summary: Example 1 @@ -75016,7 +75061,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': *516 + '503': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75039,12 +75084,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response - '503': *516 + '503': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75070,9 +75115,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *327 - - *328 - - &691 + - *332 + - *333 + - &693 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -75086,7 +75131,7 @@ paths: application/json: schema: type: array - items: &517 + items: &521 title: Porter Author description: Porter Author type: object @@ -75140,7 +75185,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': *516 + '503': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75165,8 +75210,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *327 - - *328 + - *332 + - *333 - name: author_id in: path required: true @@ -75196,7 +75241,7 @@ paths: description: Response content: application/json: - schema: *517 + schema: *521 examples: default: value: @@ -75209,7 +75254,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *516 + '503': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75233,8 +75278,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -75275,7 +75320,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *516 + '503': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75303,8 +75348,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -75331,11 +75376,11 @@ paths: description: Response content: application/json: - schema: *515 + schema: *519 examples: - default: *518 + default: *522 '422': *15 - '503': *516 + '503': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75358,8 +75403,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -75367,8 +75412,8 @@ paths: application/json: schema: *22 examples: - default: *519 - '301': *334 + default: *523 + '301': *336 '404': *6 x-github: githubCloudOnly: false @@ -75388,8 +75433,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -75397,12 +75442,12 @@ paths: application/json: schema: anyOf: - - *214 + - *220 - type: object properties: {} additionalProperties: false examples: - default: &521 + default: &525 value: limit: collaborators_only origin: repository @@ -75427,13 +75472,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: application/json: - schema: *520 + schema: *524 examples: default: summary: Example request body @@ -75445,9 +75490,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *220 examples: - default: *521 + default: *525 '409': description: Response x-github: @@ -75469,8 +75514,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -75493,8 +75538,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -75504,9 +75549,9 @@ paths: application/json: schema: type: array - items: *522 + items: *526 examples: - default: &684 + default: &686 value: - id: 1 repository: @@ -75620,7 +75665,7 @@ paths: html_url: https://github.com/octocat/Hello-World/invitations node_id: MDQ6VXNlcjE= headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75637,9 +75682,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *327 - - *328 - - *218 + - *332 + - *333 + - *224 requestBody: required: false content: @@ -75668,7 +75713,7 @@ paths: description: Response content: application/json: - schema: *522 + schema: *526 examples: default: value: @@ -75799,9 +75844,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *327 - - *328 - - *218 + - *332 + - *333 + - *224 responses: '204': description: Response @@ -75832,8 +75877,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *327 - - *328 + - *332 + - *333 - 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 @@ -75881,7 +75926,7 @@ paths: required: false schema: type: string - - *222 + - *228 - name: sort description: What to sort results by. in: query @@ -75893,8 +75938,8 @@ paths: - updated - comments default: created - - *48 - - *72 + - *52 + - *76 - *17 - *19 responses: @@ -75904,9 +75949,9 @@ paths: application/json: schema: type: array - items: *82 + items: *86 examples: - default: &532 + default: &536 value: - id: 1 node_id: MDU6SXNzdWUx @@ -76053,8 +76098,8 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *54 - '301': *334 + Link: *58 + '301': *336 '422': *15 '404': *6 x-github: @@ -76083,8 +76128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -76166,9 +76211,9 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: &529 + default: &533 value: id: 1 node_id: MDU6SXNzdWUx @@ -76322,9 +76367,9 @@ paths: '400': *14 '403': *29 '422': *15 - '503': *104 + '503': *110 '404': *6 - '410': *523 + '410': *527 x-github: triggersNotification: true githubCloudOnly: false @@ -76352,9 +76397,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *327 - - *328 - - *92 + - *332 + - *333 + - *96 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -76364,7 +76409,7 @@ paths: enum: - asc - desc - - *72 + - *76 - *17 - *19 responses: @@ -76374,9 +76419,9 @@ paths: application/json: schema: type: array - items: *524 + items: *528 examples: - default: &531 + default: &535 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -76407,7 +76452,7 @@ paths: issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR headers: - Link: *54 + Link: *58 '422': *15 '404': *6 x-github: @@ -76434,17 +76479,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 responses: '200': description: Response content: application/json: - schema: *524 + schema: *528 examples: - default: &525 + default: &529 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -76498,9 +76543,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 requestBody: required: true content: @@ -76522,9 +76567,9 @@ paths: description: Response content: application/json: - schema: *524 + schema: *528 examples: - default: *525 + default: *529 '422': *15 x-github: githubCloudOnly: false @@ -76542,9 +76587,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 responses: '204': description: Response @@ -76564,9 +76609,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 - 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. @@ -76592,11 +76637,11 @@ paths: application/json: schema: type: array - items: *320 + items: *327 examples: - default: *322 + default: *329 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -76615,9 +76660,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 requestBody: required: true content: @@ -76649,16 +76694,16 @@ paths: description: Reaction exists content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '201': description: Reaction created content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '422': *15 x-github: githubCloudOnly: false @@ -76680,10 +76725,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *327 - - *328 - - *81 - - *323 + - *332 + - *333 + - *85 + - *330 responses: '204': description: Response @@ -76703,8 +76748,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -76714,7 +76759,7 @@ paths: application/json: schema: type: array - items: &528 + items: &532 title: Issue Event description: Issue Event type: object @@ -76757,8 +76802,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *526 - required: *527 + properties: *530 + required: *531 nullable: true label: title: Issue Event Label @@ -76802,7 +76847,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *181 + requested_team: *187 dismissed_review: title: Issue Event Dismissed Review type: object @@ -76867,7 +76912,7 @@ paths: required: - from - to - author_association: *69 + author_association: *73 lock_reason: type: string nullable: true @@ -76880,8 +76925,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 required: - id - node_id @@ -77047,7 +77092,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *54 + Link: *58 '422': *15 x-github: githubCloudOnly: false @@ -77065,8 +77110,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *327 - - *328 + - *332 + - *333 - name: event_id in: path required: true @@ -77077,7 +77122,7 @@ paths: description: Response content: application/json: - schema: *528 + schema: *532 examples: default: value: @@ -77270,7 +77315,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *523 + '410': *527 '403': *29 x-github: githubCloudOnly: false @@ -77304,9 +77349,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *327 - - *328 - - &530 + - *332 + - *333 + - &534 name: issue_number description: The number that identifies the issue. in: path @@ -77318,12 +77363,12 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 - '301': *334 + default: *533 + '301': *336 '404': *6 - '410': *523 + '410': *527 '304': *37 x-github: githubCloudOnly: false @@ -77348,9 +77393,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: false content: @@ -77454,15 +77499,15 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 + default: *533 '422': *15 - '503': *104 + '503': *110 '403': *29 - '301': *334 + '301': *336 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77480,9 +77525,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: false content: @@ -77508,9 +77553,9 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 + default: *533 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77526,9 +77571,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: content: application/json: @@ -77553,9 +77598,9 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 + default: *533 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77577,9 +77622,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: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - name: assignee in: path required: true @@ -77619,10 +77664,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *327 - - *328 - - *530 - - *72 + - *332 + - *333 + - *534 + - *76 - *17 - *19 responses: @@ -77632,13 +77677,13 @@ paths: application/json: schema: type: array - items: *524 + items: *528 examples: - default: *531 + default: *535 headers: - Link: *54 + Link: *58 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77667,9 +77712,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: true content: @@ -77691,16 +77736,16 @@ paths: description: Response content: application/json: - schema: *524 + schema: *528 examples: - default: *525 + default: *529 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *523 + '410': *527 '422': *15 '404': *6 x-github: @@ -77728,9 +77773,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - *17 - *19 responses: @@ -77740,14 +77785,14 @@ paths: application/json: schema: type: array - items: *82 + items: *86 examples: - default: *532 + default: *536 headers: - Link: *54 - '301': *334 + Link: *58 + '301': *336 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77775,9 +77820,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: true content: @@ -77799,17 +77844,17 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 + default: *533 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *334 + '301': *336 '403': *29 - '410': *523 + '410': *527 '422': *15 '404': *6 x-github: @@ -77840,9 +77885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -77854,15 +77899,15 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 - '301': *334 + default: *533 + '301': *336 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *523 + '410': *527 x-github: triggersNotification: true githubCloudOnly: false @@ -77888,9 +77933,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - *17 - *19 responses: @@ -77900,14 +77945,14 @@ paths: application/json: schema: type: array - items: *82 + items: *86 examples: - default: *532 + default: *536 headers: - Link: *54 - '301': *334 + Link: *58 + '301': *336 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77924,9 +77969,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - *17 - *19 responses: @@ -77940,7 +77985,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &535 + - &539 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -77971,8 +78016,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 label: type: object properties: @@ -77994,7 +78039,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &536 + - &540 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -78025,8 +78070,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 label: type: object properties: @@ -78114,8 +78159,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 assignee: *4 assigner: *4 required: @@ -78130,7 +78175,7 @@ paths: - performed_via_github_app - assignee - assigner - - &537 + - &541 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -78161,8 +78206,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 milestone: type: object properties: @@ -78181,7 +78226,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &538 + - &542 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -78212,8 +78257,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 milestone: type: object properties: @@ -78232,7 +78277,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &539 + - &543 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -78263,8 +78308,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 rename: type: object properties: @@ -78286,7 +78331,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &540 + - &544 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -78317,10 +78362,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 review_requester: *4 - requested_team: *181 + requested_team: *187 requested_reviewer: *4 required: - review_requester @@ -78333,7 +78378,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &541 + - &545 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -78364,10 +78409,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 review_requester: *4 - requested_team: *181 + requested_team: *187 requested_reviewer: *4 required: - review_requester @@ -78380,7 +78425,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &542 + - &546 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -78411,8 +78456,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 dismissed_review: type: object properties: @@ -78440,7 +78485,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &543 + - &547 title: Locked Issue Event description: Locked Issue Event type: object @@ -78471,8 +78516,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 lock_reason: type: string example: '"off-topic"' @@ -78488,7 +78533,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &544 + - &548 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -78519,8 +78564,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 project_card: type: object properties: @@ -78554,7 +78599,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &545 + - &549 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -78585,8 +78630,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 project_card: type: object properties: @@ -78620,7 +78665,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &546 + - &550 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -78651,8 +78696,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 project_card: type: object properties: @@ -78686,7 +78731,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &547 + - &551 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -78776,8 +78821,8 @@ paths: name: label color: red headers: - Link: *54 - '410': *523 + Link: *58 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78794,9 +78839,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - *17 - *19 responses: @@ -78806,7 +78851,7 @@ paths: application/json: schema: type: array - items: &533 + items: &537 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -78853,7 +78898,7 @@ paths: - color - default examples: - default: &534 + default: &538 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -78870,10 +78915,10 @@ paths: color: a2eeef default: false headers: - Link: *54 - '301': *334 + Link: *58 + '301': *336 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78890,9 +78935,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: false content: @@ -78951,12 +78996,12 @@ paths: application/json: schema: type: array - items: *533 + items: *537 examples: - default: *534 - '301': *334 + default: *538 + '301': *336 '404': *6 - '410': *523 + '410': *527 '422': *15 x-github: githubCloudOnly: false @@ -78973,9 +79018,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: false content: @@ -79035,12 +79080,12 @@ paths: application/json: schema: type: array - items: *533 + items: *537 examples: - default: *534 - '301': *334 + default: *538 + '301': *336 '404': *6 - '410': *523 + '410': *527 '422': *15 x-github: githubCloudOnly: false @@ -79057,15 +79102,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 responses: '204': description: Response - '301': *334 + '301': *336 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79084,9 +79129,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - name: name in: path required: true @@ -79099,7 +79144,7 @@ paths: application/json: schema: type: array - items: *533 + items: *537 examples: default: value: @@ -79110,9 +79155,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *334 + '301': *336 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79132,9 +79177,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: false content: @@ -79162,7 +79207,7 @@ paths: '204': description: Response '403': *29 - '410': *523 + '410': *527 '404': *6 '422': *15 x-github: @@ -79180,9 +79225,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 responses: '204': description: Response @@ -79212,20 +79257,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 responses: '200': description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 - '301': *334 + default: *533 + '301': *336 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79242,9 +79287,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - 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. @@ -79270,13 +79315,13 @@ paths: application/json: schema: type: array - items: *320 + items: *327 examples: - default: *322 + default: *329 headers: - Link: *54 + Link: *58 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79294,9 +79339,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: true content: @@ -79328,16 +79373,16 @@ paths: description: Response content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '201': description: Response content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '422': *15 x-github: githubCloudOnly: false @@ -79359,10 +79404,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *327 - - *328 - - *530 - - *323 + - *332 + - *333 + - *534 + - *330 responses: '204': description: Response @@ -79391,9 +79436,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: true content: @@ -79415,9 +79460,9 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 + default: *533 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -79450,9 +79495,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - *17 - *19 responses: @@ -79462,13 +79507,13 @@ paths: application/json: schema: type: array - items: *82 + items: *86 examples: - default: *532 + default: *536 headers: - Link: *54 + Link: *58 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79496,9 +79541,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: true content: @@ -79525,16 +79570,16 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 + default: *533 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *523 + '410': *527 '422': *15 '404': *6 x-github: @@ -79554,9 +79599,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: true content: @@ -79587,13 +79632,13 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 + default: *533 '403': *29 '404': *6 '422': *7 - '503': *104 + '503': *110 x-github: triggersNotification: true githubCloudOnly: false @@ -79611,9 +79656,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - *17 - *19 responses: @@ -79628,10 +79673,6 @@ paths: description: Timeline Event type: object anyOf: - - *535 - - *536 - - *537 - - *538 - *539 - *540 - *541 @@ -79641,6 +79682,10 @@ paths: - *545 - *546 - *547 + - *548 + - *549 + - *550 + - *551 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -79683,7 +79728,7 @@ paths: issue_url: type: string format: uri - author_association: *69 + author_association: *73 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -79693,9 +79738,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 - reactions: *70 + properties: *71 + required: *72 + reactions: *74 required: - event - actor @@ -79726,7 +79771,7 @@ paths: properties: type: type: string - issue: *82 + issue: *86 required: - event - created_at @@ -79926,7 +79971,7 @@ paths: type: string body_text: type: string - author_association: *69 + author_association: *73 required: - event - id @@ -79949,7 +79994,7 @@ paths: type: string comments: type: array - items: &569 + items: &573 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -80038,7 +80083,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *69 + author_association: *73 _links: type: object properties: @@ -80122,7 +80167,7 @@ paths: enum: - line - file - reactions: *70 + reactions: *74 body_html: type: string example: '"

comment body

"' @@ -80158,7 +80203,7 @@ paths: type: string comments: type: array - items: *457 + items: *461 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -80189,8 +80234,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 assignee: *4 required: - id @@ -80233,8 +80278,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 assignee: *4 required: - id @@ -80277,8 +80322,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 state_reason: type: string nullable: true @@ -80445,9 +80490,9 @@ paths: type: User site_admin: true headers: - Link: *54 + Link: *58 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80464,8 +80509,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -80475,7 +80520,7 @@ paths: application/json: schema: type: array - items: &548 + items: &552 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -80525,7 +80570,7 @@ paths: last_used: '2022-01-10T15:53:42Z' enabled: true headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80541,8 +80586,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -80578,9 +80623,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *552 examples: - default: &549 + default: &553 value: id: 1 key: ssh-rsa AAA... @@ -80614,9 +80659,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *327 - - *328 - - &550 + - *332 + - *333 + - &554 name: key_id description: The unique identifier of the key. in: path @@ -80628,9 +80673,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *552 examples: - default: *549 + default: *553 '404': *6 x-github: githubCloudOnly: false @@ -80648,9 +80693,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *327 - - *328 - - *550 + - *332 + - *333 + - *554 responses: '204': description: Response @@ -80670,8 +80715,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -80681,11 +80726,11 @@ paths: application/json: schema: type: array - items: *533 + items: *537 examples: - default: *534 + default: *538 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -80704,8 +80749,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -80741,9 +80786,9 @@ paths: description: Response content: application/json: - schema: *533 + schema: *537 examples: - default: &551 + default: &555 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -80775,8 +80820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *327 - - *328 + - *332 + - *333 - name: name in: path required: true @@ -80787,9 +80832,9 @@ paths: description: Response content: application/json: - schema: *533 + schema: *537 examples: - default: *551 + default: *555 '404': *6 x-github: githubCloudOnly: false @@ -80806,8 +80851,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *327 - - *328 + - *332 + - *333 - name: name in: path required: true @@ -80846,7 +80891,7 @@ paths: description: Response content: application/json: - schema: *533 + schema: *537 examples: default: value: @@ -80872,8 +80917,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *327 - - *328 + - *332 + - *333 - name: name in: path required: true @@ -80899,8 +80944,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -80939,9 +80984,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *327 - - *328 - - *433 + - *332 + - *333 + - *437 responses: '200': description: Response @@ -81003,8 +81048,8 @@ paths: title: License Simple description: License Simple type: object - properties: *83 - required: *84 + properties: *87 + required: *88 nullable: true required: - _links @@ -81086,8 +81131,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -81152,8 +81197,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -81187,9 +81232,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *458 + schema: *462 examples: - default: *552 + default: *556 '204': description: Response when already merged '404': @@ -81214,8 +81259,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *327 - - *328 + - *332 + - *333 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -81256,12 +81301,12 @@ paths: application/json: schema: type: array - items: &553 + items: &557 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *256 - required: *257 + properties: *262 + required: *263 examples: default: value: @@ -81300,7 +81345,7 @@ paths: closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -81317,8 +81362,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -81358,9 +81403,9 @@ paths: description: Response content: application/json: - schema: *553 + schema: *557 examples: - default: &554 + default: &558 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -81419,9 +81464,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *327 - - *328 - - &555 + - *332 + - *333 + - &559 name: milestone_number description: The number that identifies the milestone. in: path @@ -81433,9 +81478,9 @@ paths: description: Response content: application/json: - schema: *553 + schema: *557 examples: - default: *554 + default: *558 '404': *6 x-github: githubCloudOnly: false @@ -81452,9 +81497,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *327 - - *328 - - *555 + - *332 + - *333 + - *559 requestBody: required: false content: @@ -81492,9 +81537,9 @@ paths: description: Response content: application/json: - schema: *553 + schema: *557 examples: - default: *554 + default: *558 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81510,9 +81555,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *327 - - *328 - - *555 + - *332 + - *333 + - *559 responses: '204': description: Response @@ -81533,9 +81578,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *327 - - *328 - - *555 + - *332 + - *333 + - *559 - *17 - *19 responses: @@ -81545,11 +81590,11 @@ paths: application/json: schema: type: array - items: *533 + items: *537 examples: - default: *534 + default: *538 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81566,12 +81611,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *327 - - *328 - - *556 - - *557 - - *72 - - *558 + - *332 + - *333 + - *560 + - *561 + - *76 + - *562 - *17 - *19 responses: @@ -81581,11 +81626,11 @@ paths: application/json: schema: type: array - items: *95 + items: *99 examples: - default: *559 + default: *563 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -81607,8 +81652,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: false content: @@ -81666,14 +81711,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: &560 + schema: &564 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -81798,7 +81843,7 @@ paths: - custom_404 - public examples: - default: &561 + default: &565 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -81839,8 +81884,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -81894,11 +81939,11 @@ paths: description: Response content: application/json: - schema: *560 + schema: *564 examples: - default: *561 + default: *565 '422': *15 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81919,8 +81964,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -81998,7 +82043,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82019,14 +82064,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response '422': *15 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82046,8 +82091,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -82057,7 +82102,7 @@ paths: application/json: schema: type: array - items: &562 + items: &566 title: Page Build description: Page Build type: object @@ -82132,7 +82177,7 @@ paths: created_at: '2014-02-10T19:00:49Z' updated_at: '2014-02-10T19:00:51Z' headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82151,8 +82196,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *327 - - *328 + - *332 + - *333 responses: '201': description: Response @@ -82197,16 +82242,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *562 + schema: *566 examples: - default: &563 + default: &567 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -82254,8 +82299,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *327 - - *328 + - *332 + - *333 - name: build_id in: path required: true @@ -82266,9 +82311,9 @@ paths: description: Response content: application/json: - schema: *562 + schema: *566 examples: - default: *563 + default: *567 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82288,8 +82333,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -82394,9 +82439,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *327 - - *328 - - &564 + - *332 + - *333 + - &568 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -82454,11 +82499,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *327 - - *328 - - *564 + - *332 + - *333 + - *568 responses: - '204': *175 + '204': *181 '404': *6 x-github: githubCloudOnly: false @@ -82483,8 +82528,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -82715,7 +82760,7 @@ paths: description: Empty response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -82742,8 +82787,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: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Private vulnerability reporting status @@ -82780,10 +82825,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: - '204': *175 + '204': *181 '422': *14 x-github: githubCloudOnly: false @@ -82802,10 +82847,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: - '204': *175 + '204': *181 '422': *14 x-github: githubCloudOnly: false @@ -82825,8 +82870,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -82834,9 +82879,9 @@ paths: application/json: schema: type: array - items: *102 + items: *108 examples: - default: *565 + default: *569 '403': *29 '404': *6 x-github: @@ -82858,8 +82903,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: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -82871,11 +82916,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *102 + items: *108 required: - properties examples: - default: *566 + default: *570 responses: '204': description: No Content when custom property values are successfully created @@ -82913,8 +82958,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *327 - - *328 + - *332 + - *333 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -82974,11 +83019,11 @@ paths: application/json: schema: type: array - items: *462 + items: *466 examples: - default: *567 + default: *571 headers: - Link: *54 + Link: *58 '304': *37 '422': *15 x-github: @@ -83008,8 +83053,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -83074,7 +83119,7 @@ paths: description: Response content: application/json: - schema: &571 + schema: &575 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -83185,8 +83230,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *256 - required: *257 + properties: *262 + required: *263 nullable: true active_lock_reason: type: string @@ -83231,7 +83276,7 @@ paths: nullable: true requested_teams: type: array - items: *305 + items: *312 nullable: true head: type: object @@ -83240,7 +83285,7 @@ paths: type: string ref: type: string - repo: *66 + repo: *70 sha: type: string user: *4 @@ -83257,7 +83302,7 @@ paths: type: string ref: type: string - repo: *66 + repo: *70 sha: type: string user: *4 @@ -83270,14 +83315,14 @@ paths: _links: type: object properties: - comments: *258 - commits: *258 - statuses: *258 - html: *258 - issue: *258 - review_comments: *258 - review_comment: *258 - self: *258 + comments: *264 + commits: *264 + statuses: *264 + html: *264 + issue: *264 + review_comments: *264 + review_comment: *264 + self: *264 required: - comments - commits @@ -83287,8 +83332,8 @@ paths: - review_comments - review_comment - self - author_association: *69 - auto_merge: *568 + author_association: *73 + auto_merge: *572 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -83380,7 +83425,7 @@ paths: - merged_by - review_comments examples: - default: &572 + default: &576 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -83907,8 +83952,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *327 - - *328 + - *332 + - *333 - name: sort in: query required: false @@ -83927,7 +83972,7 @@ paths: enum: - asc - desc - - *72 + - *76 - *17 - *19 responses: @@ -83937,9 +83982,9 @@ paths: application/json: schema: type: array - items: *569 + items: *573 examples: - default: &574 + default: &578 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -83991,7 +84036,7 @@ paths: original_line: 2 side: RIGHT headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84016,17 +84061,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 responses: '200': description: Response content: application/json: - schema: *569 + schema: *573 examples: - default: &570 + default: &574 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -84101,9 +84146,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 requestBody: required: true content: @@ -84125,9 +84170,9 @@ paths: description: Response content: application/json: - schema: *569 + schema: *573 examples: - default: *570 + default: *574 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84143,9 +84188,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 responses: '204': description: Response @@ -84166,9 +84211,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 - 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. @@ -84194,11 +84239,11 @@ paths: application/json: schema: type: array - items: *320 + items: *327 examples: - default: *322 + default: *329 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -84217,9 +84262,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 requestBody: required: true content: @@ -84251,16 +84296,16 @@ paths: description: Reaction exists content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '201': description: Reaction created content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '422': *15 x-github: githubCloudOnly: false @@ -84282,10 +84327,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *327 - - *328 - - *81 - - *323 + - *332 + - *333 + - *85 + - *330 responses: '204': description: Response @@ -84328,9 +84373,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *327 - - *328 - - &573 + - *332 + - *333 + - &577 name: pull_number description: The number that identifies the pull request. in: path @@ -84343,9 +84388,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *571 + schema: *575 examples: - default: *572 + default: *576 '304': *37 '404': *6 '406': @@ -84353,8 +84398,8 @@ paths: content: application/json: schema: *3 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84380,9 +84425,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 requestBody: required: false content: @@ -84424,9 +84469,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *575 examples: - default: *572 + default: *576 '422': *15 '403': *29 x-github: @@ -84448,9 +84493,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 requestBody: required: true content: @@ -84510,21 +84555,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *224 + schema: *230 examples: - default: *447 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *224 + schema: *230 examples: - default: *447 + default: *451 '401': *25 '403': *29 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -84550,10 +84595,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *327 - - *328 - - *573 - - *92 + - *332 + - *333 + - *577 + - *96 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -84563,7 +84608,7 @@ paths: enum: - asc - desc - - *72 + - *76 - *17 - *19 responses: @@ -84573,11 +84618,11 @@ paths: application/json: schema: type: array - items: *569 + items: *573 examples: - default: *574 + default: *578 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84608,9 +84653,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 requestBody: required: true content: @@ -84715,7 +84760,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *573 examples: example-for-a-multi-line-comment: value: @@ -84803,10 +84848,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *327 - - *328 - - *573 - - *81 + - *332 + - *333 + - *577 + - *85 requestBody: required: true content: @@ -84828,7 +84873,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *573 examples: default: value: @@ -84914,9 +84959,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 - *17 - *19 responses: @@ -84926,11 +84971,11 @@ paths: application/json: schema: type: array - items: *458 + items: *462 examples: - default: *575 + default: *579 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84958,9 +85003,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 - *17 - *19 responses: @@ -84970,7 +85015,7 @@ paths: application/json: schema: type: array - items: *471 + items: *475 examples: default: value: @@ -84986,10 +85031,10 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" headers: - Link: *54 + Link: *58 '422': *15 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85008,9 +85053,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 responses: '204': description: Response if pull request has been merged @@ -85033,9 +85078,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 requestBody: required: false content: @@ -85146,9 +85191,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 responses: '200': description: Response @@ -85164,7 +85209,7 @@ paths: items: *4 teams: type: array - items: *181 + items: *187 required: - users - teams @@ -85205,7 +85250,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85223,9 +85268,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 requestBody: required: false content: @@ -85262,7 +85307,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *466 examples: default: value: @@ -85798,9 +85843,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 requestBody: required: true content: @@ -85834,7 +85879,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *466 examples: default: value: @@ -86339,9 +86384,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 - *17 - *19 responses: @@ -86351,7 +86396,7 @@ paths: application/json: schema: type: array - items: &576 + items: &580 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -86420,7 +86465,7 @@ paths: type: string body_text: type: string - author_association: *69 + author_association: *73 required: - id - node_id @@ -86469,7 +86514,7 @@ paths: commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 author_association: COLLABORATOR headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86502,9 +86547,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 requestBody: required: false content: @@ -86590,9 +86635,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: &578 + default: &582 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -86655,10 +86700,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 - - &577 + - *332 + - *333 + - *577 + - &581 name: review_id description: The unique identifier of the review. in: path @@ -86670,9 +86715,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: &579 + default: &583 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -86731,10 +86776,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 - *577 + - *581 requestBody: required: true content: @@ -86757,7 +86802,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: default: value: @@ -86819,18 +86864,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 - *577 + - *581 responses: '200': description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: *578 + default: *582 '422': *7 '404': *6 x-github: @@ -86857,10 +86902,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *327 - - *328 - - *573 + - *332 + - *333 - *577 + - *581 - *17 - *19 responses: @@ -86939,13 +86984,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *69 + author_association: *73 _links: type: object properties: - self: *258 - html: *258 - pull_request: *258 + self: *264 + html: *264 + pull_request: *264 required: - self - html @@ -86954,7 +86999,7 @@ paths: type: string body_html: type: string - reactions: *70 + reactions: *74 side: description: The side of the first line of the range for a multi-line comment. @@ -87066,7 +87111,7 @@ paths: pull_request: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -87095,10 +87140,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 - *577 + - *581 requestBody: required: true content: @@ -87126,7 +87171,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: default: value: @@ -87189,10 +87234,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 - *577 + - *581 requestBody: required: true content: @@ -87227,9 +87272,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: *579 + default: *583 '404': *6 '422': *7 '403': *29 @@ -87251,9 +87296,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 requestBody: required: false content: @@ -87316,8 +87361,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *327 - - *328 + - *332 + - *333 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -87330,9 +87375,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *584 examples: - default: &581 + default: &585 value: type: file encoding: base64 @@ -87374,8 +87419,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *327 - - *328 + - *332 + - *333 - name: dir description: The alternate path to look for a README file in: path @@ -87395,9 +87440,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *584 examples: - default: *581 + default: *585 '404': *6 '422': *15 x-github: @@ -87419,8 +87464,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -87430,7 +87475,7 @@ paths: application/json: schema: type: array - items: &582 + items: &586 title: Release description: A release. type: object @@ -87501,7 +87546,7 @@ paths: author: *4 assets: type: array - items: &583 + items: &587 title: Release Asset description: Data related to a release. type: object @@ -87576,7 +87621,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *70 + reactions: *74 required: - assets_url - upload_url @@ -87668,7 +87713,7 @@ paths: type: User site_admin: false headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -87688,8 +87733,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -87765,9 +87810,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: &586 + default: &590 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -87872,9 +87917,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *327 - - *328 - - &584 + - *332 + - *333 + - &588 name: asset_id description: The unique identifier of the asset. in: path @@ -87886,9 +87931,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *587 examples: - default: &585 + default: &589 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 @@ -87923,7 +87968,7 @@ paths: type: User site_admin: false '404': *6 - '302': *473 + '302': *477 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87939,9 +87984,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *327 - - *328 - - *584 + - *332 + - *333 + - *588 requestBody: required: false content: @@ -87969,9 +88014,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *587 examples: - default: *585 + default: *589 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87987,9 +88032,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *327 - - *328 - - *584 + - *332 + - *333 + - *588 responses: '204': description: Response @@ -88013,8 +88058,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -88099,16 +88144,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88125,8 +88170,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *327 - - *328 + - *332 + - *333 - name: tag description: tag parameter in: path @@ -88139,9 +88184,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 '404': *6 x-github: githubCloudOnly: false @@ -88163,9 +88208,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *327 - - *328 - - &587 + - *332 + - *333 + - &591 name: release_id description: The unique identifier of the release. in: path @@ -88179,9 +88224,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 '401': description: Unauthorized x-github: @@ -88199,9 +88244,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *327 - - *328 - - *587 + - *332 + - *333 + - *591 requestBody: required: false content: @@ -88265,9 +88310,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 '404': description: Not Found if the discussion category name is invalid content: @@ -88288,9 +88333,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *327 - - *328 - - *587 + - *332 + - *333 + - *591 responses: '204': description: Response @@ -88310,9 +88355,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *327 - - *328 - - *587 + - *332 + - *333 + - *591 - *17 - *19 responses: @@ -88322,7 +88367,7 @@ paths: application/json: schema: type: array - items: *583 + items: *587 examples: default: value: @@ -88359,7 +88404,7 @@ paths: type: User site_admin: false headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88403,9 +88448,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: - - *327 - - *328 - - *587 + - *332 + - *333 + - *591 - name: name in: query required: true @@ -88431,7 +88476,7 @@ paths: description: Response for successful upload content: application/json: - schema: *583 + schema: *587 examples: response-for-successful-upload: value: @@ -88486,9 +88531,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *327 - - *328 - - *587 + - *332 + - *333 + - *591 - 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. @@ -88512,11 +88557,11 @@ paths: application/json: schema: type: array - items: *320 + items: *327 examples: - default: *322 + default: *329 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -88535,9 +88580,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *327 - - *328 - - *587 + - *332 + - *333 + - *591 requestBody: required: true content: @@ -88567,16 +88612,16 @@ paths: description: Reaction exists content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '201': description: Reaction created content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '422': *15 x-github: githubCloudOnly: false @@ -88598,10 +88643,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *327 - - *328 - - *587 - - *323 + - *332 + - *333 + - *591 + - *330 responses: '204': description: Response @@ -88625,9 +88670,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 - *17 - *19 responses: @@ -88643,8 +88688,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *278 - - &588 + - *284 + - &592 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -88663,69 +88708,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *279 - - *588 - - allOf: - - *280 - - *588 - - allOf: - - *281 - - *588 - - allOf: - - *589 - - *588 - - allOf: - - *282 - - *588 - - allOf: - - *283 - - *588 - - allOf: - - *284 - - *588 - allOf: - *285 - - *588 + - *592 - allOf: - *286 - - *588 + - *592 - allOf: - *287 - - *588 + - *592 + - allOf: + - *593 + - *592 - allOf: - *288 - - *588 + - *592 - allOf: - *289 - - *588 + - *592 - allOf: - *290 - - *588 + - *592 - allOf: - *291 - - *588 + - *592 - allOf: - *292 - - *588 + - *592 - allOf: - *293 - - *588 + - *592 - allOf: - *294 - - *588 + - *592 - allOf: - *295 - - *588 + - *592 - allOf: - *296 - - *588 + - *592 - allOf: - *297 - - *588 + - *592 + - allOf: + - *298 + - *592 - allOf: - - *590 - - *588 + - *299 + - *592 + - allOf: + - *300 + - *592 + - allOf: + - *301 + - *592 + - allOf: + - *302 + - *592 + - allOf: + - *303 + - *592 + - allOf: + - *304 + - *592 examples: default: value: @@ -88764,8 +88809,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 - name: includes_parents @@ -88776,7 +88821,7 @@ paths: schema: type: boolean default: true - - *591 + - *594 responses: '200': description: Response @@ -88784,7 +88829,7 @@ paths: application/json: schema: type: array - items: *298 + items: *305 examples: default: value: @@ -88815,7 +88860,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *103 + '500': *109 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -88831,8 +88876,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *332 + - *333 requestBody: description: Request body required: true @@ -88852,16 +88897,16 @@ paths: - tag - push default: branch - enforcement: *275 + enforcement: *281 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *276 - conditions: *273 + items: *282 + conditions: *279 rules: type: array description: An array of rules within the ruleset. - items: *592 + items: *595 required: - name - enforcement @@ -88892,9 +88937,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: &602 + default: &605 value: id: 42 name: super cool ruleset @@ -88927,7 +88972,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *6 - '500': *103 + '500': *109 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -88941,12 +88986,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *327 - - *328 - - *593 - - *594 - - *595 + - *332 + - *333 - *596 + - *597 + - *598 + - *599 - *17 - *19 responses: @@ -88954,11 +88999,11 @@ paths: description: Response content: application/json: - schema: *597 + schema: *600 examples: - default: *598 + default: *601 '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88977,19 +89022,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *327 - - *328 - - *599 + - *332 + - *333 + - *602 responses: '200': description: Response content: application/json: - schema: *600 + schema: *603 examples: - default: *601 + default: *604 '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89015,8 +89060,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *332 + - *333 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89036,11 +89081,11 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *602 + default: *605 '404': *6 - '500': *103 + '500': *109 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -89056,8 +89101,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *332 + - *333 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89082,16 +89127,16 @@ paths: - branch - tag - push - enforcement: *275 + enforcement: *281 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *276 - conditions: *273 + items: *282 + conditions: *279 rules: description: An array of rules within the ruleset. type: array - items: *592 + items: *595 examples: default: value: @@ -89119,11 +89164,11 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *602 + default: *605 '404': *6 - '500': *103 + '500': *109 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -89139,8 +89184,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *332 + - *333 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89151,7 +89196,7 @@ paths: '204': description: Response '404': *6 - '500': *103 + '500': *109 "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": get: summary: Get repository ruleset history @@ -89163,8 +89208,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 - name: ruleset_id @@ -89180,11 +89225,11 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *603 + default: *606 '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89201,8 +89246,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *327 - - *328 + - *332 + - *333 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89220,7 +89265,7 @@ paths: description: Response content: application/json: - schema: *604 + schema: *607 examples: default: value: @@ -89253,7 +89298,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89275,21 +89320,22 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *327 - - *328 - - *605 - - *606 - - *607 + - *332 + - *333 - *608 - - *48 - - *19 - - *17 - *609 - *610 - *611 - *612 + - *52 + - *19 + - *17 - *613 - *614 + - *615 + - *616 + - *617 + - *618 responses: '200': description: Response @@ -89297,11 +89343,11 @@ paths: application/json: schema: type: array - items: &618 + items: &622 type: object properties: - number: *161 - created_at: *162 + number: *167 + created_at: *168 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -89309,15 +89355,15 @@ paths: format: date-time readOnly: true nullable: true - url: *164 - html_url: *165 + url: *170 + html_url: *171 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *615 - resolution: *616 + state: *619 + resolution: *620 resolved_at: type: string format: date-time @@ -89413,7 +89459,7 @@ paths: pull request. ' - oneOf: *617 + oneOf: *621 nullable: true has_more_locations: type: boolean @@ -89540,7 +89586,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89562,16 +89608,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *327 - - *328 - - *427 - - *614 + - *332 + - *333 + - *431 + - *618 responses: '200': description: Response content: application/json: - schema: *618 + schema: *622 examples: default: value: @@ -89602,7 +89648,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89613,6 +89659,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. @@ -89623,9 +89671,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *327 - - *328 - - *427 + - *332 + - *333 + - *431 requestBody: required: true content: @@ -89633,27 +89681,42 @@ paths: schema: type: object properties: - state: *615 - resolution: *616 + state: *619 + resolution: *620 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true + assignee: + description: The username of the user to assign to the alert. Set + to `null` to unassign the alert. + type: string + nullable: true 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: *618 + schema: *622 examples: default: value: @@ -89698,6 +89761,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. @@ -89705,8 +89787,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': *104 + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository + '503': *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -89728,9 +89811,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *327 - - *328 - - *427 + - *332 + - *333 + - *431 - *19 - *17 responses: @@ -89741,7 +89824,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &770 + items: &781 type: object properties: type: @@ -89767,10 +89850,6 @@ paths: example: commit details: oneOf: - - *619 - - *620 - - *621 - - *622 - *623 - *624 - *625 @@ -89780,6 +89859,10 @@ paths: - *629 - *630 - *631 + - *632 + - *633 + - *634 + - *635 examples: default: value: @@ -89839,11 +89922,11 @@ paths: details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 headers: - Link: *54 + Link: *58 '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89865,8 +89948,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -89874,14 +89957,14 @@ paths: schema: type: object properties: - reason: &633 + reason: &637 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *632 + placeholder_id: *636 required: - reason - placeholder_id @@ -89898,7 +89981,7 @@ paths: schema: type: object properties: - reason: *633 + reason: *637 expire_at: type: string format: date-time @@ -89921,7 +90004,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *104 + '503': *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -89944,13 +90027,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: - - *327 - - *328 + - *332 + - *333 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *104 + '503': *110 '200': description: Response content: @@ -89960,7 +90043,7 @@ paths: properties: incremental_scans: type: array - items: &634 + items: &638 description: Information on a single scan performed by secret scanning on the repository type: object @@ -89986,15 +90069,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *634 + items: *638 backfill_scans: type: array - items: *634 + items: *638 custom_pattern_backfill_scans: type: array items: allOf: - - *634 + - *638 - type: object properties: pattern_name: @@ -90064,9 +90147,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *327 - - *328 - - *48 + - *332 + - *333 + - *52 - name: sort description: The property to sort the results by. in: query @@ -90078,8 +90161,8 @@ paths: - updated - published default: created - - *40 - - *41 + - *45 + - *46 - 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)." @@ -90109,9 +90192,9 @@ paths: application/json: schema: type: array - items: *635 + items: *639 examples: - default: *636 + default: *640 '400': *14 '404': *6 x-github: @@ -90134,8 +90217,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -90208,7 +90291,7 @@ paths: login: type: string description: The username of the user credited. - type: *304 + type: *311 required: - login - type @@ -90295,9 +90378,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *639 examples: - default: &638 + default: &642 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -90530,8 +90613,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -90635,7 +90718,7 @@ paths: description: Response content: application/json: - schema: *635 + schema: *639 examples: default: value: @@ -90782,17 +90865,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *327 - - *328 - - *637 + - *332 + - *333 + - *641 responses: '200': description: Response content: application/json: - schema: *635 + schema: *639 examples: - default: *638 + default: *642 '403': *29 '404': *6 x-github: @@ -90816,9 +90899,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *327 - - *328 - - *637 + - *332 + - *333 + - *641 requestBody: required: true content: @@ -90891,7 +90974,7 @@ paths: login: type: string description: The username of the user credited. - type: *304 + type: *311 required: - login - type @@ -90977,17 +91060,17 @@ paths: description: Response content: application/json: - schema: *635 + schema: *639 examples: - default: *638 - add_credit: *638 + default: *642 + add_credit: *642 '403': *29 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *112 + schema: *118 examples: invalid_state_transition: value: @@ -91018,9 +91101,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: - - *327 - - *328 - - *637 + - *332 + - *333 + - *641 responses: '202': *39 '400': *14 @@ -91047,17 +91130,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *327 - - *328 - - *637 + - *332 + - *333 + - *641 responses: '202': description: Response content: application/json: - schema: *333 + schema: *335 examples: - default: *335 + default: *337 '400': *14 '422': *15 '403': *29 @@ -91083,8 +91166,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -91161,7 +91244,7 @@ paths: type: User site_admin: false headers: - Link: *54 + Link: *58 '422': *15 x-github: githubCloudOnly: false @@ -91183,8 +91266,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -91193,7 +91276,7 @@ paths: application/json: schema: type: array - items: &639 + items: &643 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -91206,7 +91289,7 @@ paths: - 1124 - -435 '202': *39 - '204': *175 + '204': *181 '422': description: Repository contains more than 10,000 commits x-github: @@ -91226,8 +91309,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -91276,7 +91359,7 @@ paths: total: 89 week: 1336280400 '202': *39 - '204': *175 + '204': *181 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91303,8 +91386,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -91378,7 +91461,7 @@ paths: d: 77 c: 10 '202': *39 - '204': *175 + '204': *181 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91400,8 +91483,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -91555,8 +91638,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -91566,7 +91649,7 @@ paths: application/json: schema: type: array - items: *639 + items: *643 examples: default: value: @@ -91579,7 +91662,7 @@ paths: - - 0 - 2 - 21 - '204': *175 + '204': *181 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91599,8 +91682,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *327 - - *328 + - *332 + - *333 - name: sha in: path required: true @@ -91654,7 +91737,7 @@ paths: description: Response content: application/json: - schema: *640 + schema: *644 examples: default: value: @@ -91708,8 +91791,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -91721,9 +91804,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91741,14 +91824,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &641 + schema: &645 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -91816,8 +91899,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: false content: @@ -91843,7 +91926,7 @@ paths: description: Response content: application/json: - schema: *641 + schema: *645 examples: default: value: @@ -91870,8 +91953,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -91891,8 +91974,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -91948,7 +92031,7 @@ paths: tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91971,8 +92054,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -91980,7 +92063,7 @@ paths: application/json: schema: type: array - items: &642 + items: &646 title: Tag protection description: Tag protection type: object @@ -92032,8 +92115,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: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -92056,7 +92139,7 @@ paths: description: Response content: application/json: - schema: *642 + schema: *646 examples: default: value: @@ -92087,8 +92170,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: - - *327 - - *328 + - *332 + - *333 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -92125,8 +92208,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *327 - - *328 + - *332 + - *333 - name: ref in: path required: true @@ -92162,8 +92245,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -92173,11 +92256,11 @@ paths: application/json: schema: type: array - items: *181 + items: *187 examples: - default: *236 + default: *242 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -92195,8 +92278,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *327 - - *328 + - *332 + - *333 - *19 - *17 responses: @@ -92204,7 +92287,7 @@ paths: description: Response content: application/json: - schema: &643 + schema: &647 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -92216,7 +92299,7 @@ paths: required: - names examples: - default: &644 + default: &648 value: names: - octocat @@ -92239,8 +92322,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -92271,9 +92354,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *647 examples: - default: *644 + default: *648 '404': *6 '422': *7 x-github: @@ -92294,9 +92377,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *327 - - *328 - - &645 + - *332 + - *333 + - &649 name: per description: The time frame to display results for. in: query @@ -92325,7 +92408,7 @@ paths: example: 128 clones: type: array - items: &646 + items: &650 title: Traffic type: object properties: @@ -92412,8 +92495,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -92503,8 +92586,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -92564,9 +92647,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *327 - - *328 - - *645 + - *332 + - *333 + - *649 responses: '200': description: Response @@ -92585,7 +92668,7 @@ paths: example: 3782 views: type: array - items: *646 + items: *650 required: - uniques - count @@ -92662,8 +92745,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -92699,7 +92782,7 @@ paths: description: Response content: application/json: - schema: *143 + schema: *149 examples: default: value: @@ -92937,8 +93020,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -92961,8 +93044,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -92984,8 +93067,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -93011,8 +93094,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *327 - - *328 + - *332 + - *333 - name: ref in: path required: true @@ -93104,9 +93187,9 @@ paths: description: Response content: application/json: - schema: *333 + schema: *335 examples: - default: *335 + default: *337 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -93147,7 +93230,7 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: default: value: @@ -93336,7 +93419,7 @@ paths: html_url: type: string format: uri - repository: *143 + repository: *149 score: type: number file_size: @@ -93354,7 +93437,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &647 + text_matches: &651 title: Search Result Text Matches type: array items: @@ -93468,7 +93551,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *104 + '503': *110 '422': *15 '403': *29 x-github: @@ -93516,7 +93599,7 @@ paths: enum: - author-date - committer-date - - &648 + - &652 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 @@ -93587,7 +93670,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *393 + properties: *397 nullable: true comment_count: type: integer @@ -93607,7 +93690,7 @@ paths: url: type: string format: uri - verification: *509 + verification: *513 required: - author - committer @@ -93626,7 +93709,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *393 + properties: *397 nullable: true parents: type: array @@ -93639,12 +93722,12 @@ paths: type: string sha: type: string - repository: *143 + repository: *149 score: type: number node_id: type: string - text_matches: *647 + text_matches: *651 required: - sha - node_id @@ -93836,7 +93919,7 @@ paths: - interactions - created - updated - - *648 + - *652 - *17 - *19 - name: advanced_search @@ -93933,11 +94016,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: type: string state_reason: @@ -93954,8 +94037,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *256 - required: *257 + properties: *262 + required: *263 nullable: true comments: type: integer @@ -93969,7 +94052,7 @@ paths: type: string format: date-time nullable: true - text_matches: *647 + text_matches: *651 pull_request: type: object properties: @@ -94002,10 +94085,10 @@ paths: type: string score: type: number - author_association: *69 + author_association: *73 draft: type: boolean - repository: *66 + repository: *70 body_html: type: string body_text: @@ -94013,7 +94096,7 @@ paths: timeline_url: type: string format: uri - type: *219 + type: *225 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -94023,9 +94106,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 - reactions: *70 + properties: *71 + required: *72 + reactions: *74 required: - assignee - closed_at @@ -94141,7 +94224,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *104 + '503': *110 '422': *15 '304': *37 '403': *29 @@ -94194,7 +94277,7 @@ paths: enum: - created - updated - - *648 + - *652 - *17 - *19 responses: @@ -94238,7 +94321,7 @@ paths: nullable: true score: type: number - text_matches: *647 + text_matches: *651 required: - id - node_id @@ -94323,7 +94406,7 @@ paths: - forks - help-wanted-issues - updated - - *648 + - *652 - *17 - *19 responses: @@ -94542,8 +94625,8 @@ paths: title: License Simple description: License Simple type: object - properties: *83 - required: *84 + properties: *87 + required: *88 nullable: true permissions: type: object @@ -94562,7 +94645,7 @@ paths: - admin - pull - push - text_matches: *647 + text_matches: *651 temp_clone_token: type: string allow_merge_commit: @@ -94764,7 +94847,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *104 + '503': *110 '422': *15 '304': *37 x-github: @@ -94862,7 +94945,7 @@ paths: type: string format: uri nullable: true - text_matches: *647 + text_matches: *651 related: type: array nullable: true @@ -95053,7 +95136,7 @@ paths: - followers - repositories - joined - - *648 + - *652 - *17 - *19 responses: @@ -95157,7 +95240,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *647 + text_matches: *651 blog: type: string nullable: true @@ -95216,7 +95299,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *104 + '503': *110 '422': *15 x-github: githubCloudOnly: false @@ -95236,7 +95319,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &652 + - &656 name: team_id description: The unique identifier of the team. in: path @@ -95248,9 +95331,9 @@ paths: description: Response content: application/json: - schema: *312 + schema: *319 examples: - default: *313 + default: *320 '404': *6 x-github: githubCloudOnly: false @@ -95277,7 +95360,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *652 + - *656 requestBody: required: true content: @@ -95340,16 +95423,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *312 + schema: *319 examples: - default: *313 + default: *320 '201': description: Response content: application/json: - schema: *312 + schema: *319 examples: - default: *313 + default: *320 '404': *6 '422': *15 '403': *29 @@ -95377,7 +95460,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *652 + - *656 responses: '204': description: Response @@ -95408,8 +95491,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *652 - - *48 + - *656 + - *52 - *17 - *19 responses: @@ -95419,11 +95502,11 @@ paths: application/json: schema: type: array - items: *314 + items: *321 examples: - default: *653 + default: *657 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95450,7 +95533,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *652 + - *656 requestBody: required: true content: @@ -95484,9 +95567,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 x-github: triggersNotification: true githubCloudOnly: false @@ -95513,16 +95596,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *652 - - *316 + - *656 + - *323 responses: '200': description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95547,8 +95630,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *652 - - *316 + - *656 + - *323 requestBody: required: false content: @@ -95571,9 +95654,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *654 + default: *658 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95598,8 +95681,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *652 - - *316 + - *656 + - *323 responses: '204': description: Response @@ -95628,9 +95711,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *652 - - *316 - - *48 + - *656 + - *323 + - *52 - *17 - *19 responses: @@ -95640,11 +95723,11 @@ paths: application/json: schema: type: array - items: *317 + items: *324 examples: - default: *655 + default: *659 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95671,8 +95754,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *652 - - *316 + - *656 + - *323 requestBody: required: true content: @@ -95694,9 +95777,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *324 examples: - default: *318 + default: *325 x-github: triggersNotification: true githubCloudOnly: false @@ -95723,17 +95806,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *652 - - *316 - - *319 + - *656 + - *323 + - *326 responses: '200': description: Response content: application/json: - schema: *317 + schema: *324 examples: - default: *318 + default: *325 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95758,9 +95841,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *652 - - *316 - - *319 + - *656 + - *323 + - *326 requestBody: required: true content: @@ -95782,9 +95865,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *324 examples: - default: *656 + default: *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95809,9 +95892,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *652 - - *316 - - *319 + - *656 + - *323 + - *326 responses: '204': description: Response @@ -95840,9 +95923,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *652 - - *316 - - *319 + - *656 + - *323 + - *326 - 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. @@ -95868,11 +95951,11 @@ paths: application/json: schema: type: array - items: *320 + items: *327 examples: - default: *322 + default: *329 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95899,9 +95982,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *652 - - *316 - - *319 + - *656 + - *323 + - *326 requestBody: required: true content: @@ -95933,9 +96016,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95961,8 +96044,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *652 - - *316 + - *656 + - *323 - 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. @@ -95988,11 +96071,11 @@ paths: application/json: schema: type: array - items: *320 + items: *327 examples: - default: *322 + default: *329 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96019,8 +96102,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *652 - - *316 + - *656 + - *323 requestBody: required: true content: @@ -96052,9 +96135,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96078,7 +96161,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *652 + - *656 - *17 - *19 responses: @@ -96088,11 +96171,11 @@ paths: application/json: schema: type: array - items: *216 + items: *222 examples: - default: *217 + default: *223 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96116,7 +96199,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *652 + - *656 - name: role description: Filters members returned by their role in the team. in: query @@ -96139,9 +96222,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -96167,8 +96250,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *652 - - *59 + - *656 + - *63 responses: '204': description: if user is a member @@ -96204,8 +96287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *652 - - *59 + - *656 + - *63 responses: '204': description: Response @@ -96244,8 +96327,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *652 - - *59 + - *656 + - *63 responses: '204': description: Response @@ -96281,16 +96364,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *652 - - *59 + - *656 + - *63 responses: '200': description: Response content: application/json: - schema: *324 + schema: *331 examples: - response-if-user-is-a-team-maintainer: *657 + response-if-user-is-a-team-maintainer: *661 '404': *6 x-github: githubCloudOnly: false @@ -96323,8 +96406,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *652 - - *59 + - *656 + - *63 requestBody: required: false content: @@ -96349,9 +96432,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *331 examples: - response-if-users-membership-with-team-is-now-pending: *658 + response-if-users-membership-with-team-is-now-pending: *662 '403': description: Forbidden if team synchronization is set up '422': @@ -96385,8 +96468,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *652 - - *59 + - *656 + - *63 responses: '204': description: Response @@ -96400,174 +96483,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: - - *652 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *325 - examples: - default: *659 - headers: - Link: *54 - '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: - - *652 - - *326 - responses: - '200': - description: Response - content: - application/json: - schema: *325 - examples: - default: *660 - '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: - - *652 - - *326 - 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: - - *652 - - *326 - 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) @@ -96581,7 +96496,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *652 + - *656 - *17 - *19 responses: @@ -96591,11 +96506,11 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: *243 + default: *249 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -96623,15 +96538,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *652 - - *327 - - *328 + - *656 + - *332 + - *333 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *661 + schema: *663 examples: alternative-response-with-extra-repository-information: value: @@ -96782,9 +96697,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *652 - - *327 - - *328 + - *656 + - *332 + - *333 requestBody: required: false content: @@ -96834,9 +96749,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *652 - - *327 - - *328 + - *656 + - *332 + - *333 responses: '204': description: Response @@ -96861,7 +96776,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *652 + - *656 - *17 - *19 responses: @@ -96871,11 +96786,11 @@ paths: application/json: schema: type: array - items: *181 + items: *187 examples: - response-if-child-teams-exist: *662 + response-if-child-teams-exist: *664 headers: - Link: *54 + Link: *58 '404': *6 '403': *29 '422': *15 @@ -96906,7 +96821,7 @@ paths: application/json: schema: oneOf: - - &664 + - &666 title: Private User description: Private User type: object @@ -97109,7 +97024,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *663 + - *665 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -97262,7 +97177,7 @@ paths: description: Response content: application/json: - schema: *664 + schema: *666 examples: default: value: @@ -97341,7 +97256,7 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 '304': *37 '404': *6 '403': *29 @@ -97364,7 +97279,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: - - *59 + - *63 responses: '204': description: If the user is blocked @@ -97392,7 +97307,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *59 + - *63 responses: '204': description: Response @@ -97416,7 +97331,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *59 + - *63 responses: '204': description: Response @@ -97465,11 +97380,11 @@ paths: type: integer codespaces: type: array - items: *224 + items: *230 examples: - default: *225 + default: *231 '304': *37 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -97606,21 +97521,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *224 + schema: *230 examples: - default: *447 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *224 + schema: *230 examples: - default: *447 + default: *451 '401': *25 '403': *29 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97660,7 +97575,7 @@ paths: type: integer secrets: type: array - items: &665 + items: &667 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -97700,9 +97615,9 @@ paths: - visibility - selected_repositories_url examples: - default: *450 + default: *454 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97770,13 +97685,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *151 + - *157 responses: '200': description: Response content: application/json: - schema: *665 + schema: *667 examples: default: value: @@ -97806,7 +97721,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *151 + - *157 requestBody: required: true content: @@ -97851,7 +97766,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -97879,7 +97794,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *151 + - *157 responses: '204': description: Response @@ -97904,7 +97819,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *151 + - *157 responses: '200': description: Response @@ -97920,13 +97835,13 @@ paths: type: integer repositories: type: array - items: *143 + items: *149 examples: - default: *666 + default: *668 '401': *25 '403': *29 '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97947,7 +97862,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *151 + - *157 requestBody: required: true content: @@ -97979,7 +97894,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98001,7 +97916,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *151 + - *157 - name: repository_id in: path required: true @@ -98013,7 +97928,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98034,7 +97949,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *151 + - *157 - name: repository_id in: path required: true @@ -98046,7 +97961,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98066,17 +97981,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *226 + - *232 responses: '200': description: Response content: application/json: - schema: *224 + schema: *230 examples: - default: *447 + default: *451 '304': *37 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -98100,7 +98015,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *226 + - *232 requestBody: required: false content: @@ -98130,9 +98045,9 @@ paths: description: Response content: application/json: - schema: *224 + schema: *230 examples: - default: *447 + default: *451 '401': *25 '403': *29 '404': *6 @@ -98154,11 +98069,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *226 + - *232 responses: '202': *39 '304': *37 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -98183,13 +98098,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *226 + - *232 responses: '202': description: Response content: application/json: - schema: &667 + schema: &669 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -98230,7 +98145,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &668 + default: &670 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -98238,7 +98153,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -98262,7 +98177,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *226 + - *232 - name: export_id in: path required: true @@ -98275,9 +98190,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *669 examples: - default: *668 + default: *670 '404': *6 x-github: githubCloudOnly: false @@ -98298,7 +98213,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *226 + - *232 responses: '200': description: Response @@ -98314,11 +98229,11 @@ paths: type: integer machines: type: array - items: *669 + items: *671 examples: - default: *670 + default: *672 '304': *37 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -98345,7 +98260,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *226 + - *232 requestBody: required: true content: @@ -98395,13 +98310,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *333 + repository: *335 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *448 - required: *449 + properties: *452 + required: *453 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -99175,17 +99090,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *226 + - *232 responses: '200': description: Response content: application/json: - schema: *224 + schema: *230 examples: - default: *447 + default: *451 '304': *37 - '500': *103 + '500': *109 '400': *14 '401': *25 '402': @@ -99195,7 +99110,7 @@ paths: schema: *3 '403': *29 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99215,16 +99130,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *226 + - *232 responses: '200': description: Response content: application/json: - schema: *224 + schema: *230 examples: - default: *447 - '500': *103 + default: *451 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -99253,9 +99168,9 @@ paths: application/json: schema: type: array - items: *237 + items: *243 examples: - default: &681 + default: &683 value: - id: 197 name: hello_docker @@ -99356,7 +99271,7 @@ paths: application/json: schema: type: array - items: &671 + items: &673 title: Email description: Email type: object @@ -99421,16 +99336,16 @@ paths: application/json: schema: type: array - items: *671 + items: *673 examples: - default: &683 + default: &685 value: - email: octocat@github.com verified: true primary: true visibility: public headers: - Link: *54 + Link: *58 '304': *37 '404': *6 '403': *29 @@ -99498,7 +99413,7 @@ paths: application/json: schema: type: array - items: *671 + items: *673 examples: default: value: @@ -99608,9 +99523,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -99641,9 +99556,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -99663,7 +99578,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: - - *59 + - *63 responses: '204': description: if the person is followed by the authenticated user @@ -99693,7 +99608,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *59 + - *63 responses: '204': description: Response @@ -99718,7 +99633,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *59 + - *63 responses: '204': description: Response @@ -99754,7 +99669,7 @@ paths: application/json: schema: type: array - items: &672 + items: &674 title: GPG Key description: A unique encryption key type: object @@ -99885,7 +99800,7 @@ paths: - subkeys - revoked examples: - default: &697 + default: &699 value: - id: 3 name: Octocat's GPG Key @@ -99917,7 +99832,7 @@ paths: revoked: false raw_key: string headers: - Link: *54 + Link: *58 '304': *37 '404': *6 '403': *29 @@ -99970,9 +99885,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *674 examples: - default: &673 + default: &675 value: id: 3 name: Octocat's GPG Key @@ -100029,7 +99944,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &674 + - &676 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -100041,9 +99956,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *674 examples: - default: *673 + default: *675 '404': *6 '304': *37 '403': *29 @@ -100066,7 +99981,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *674 + - *676 responses: '204': description: Response @@ -100209,7 +100124,7 @@ paths: suspended_at: suspended_by: headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -100255,11 +100170,11 @@ paths: type: string repositories: type: array - items: *66 + items: *70 examples: - default: *135 + default: *141 headers: - Link: *54 + Link: *58 '404': *6 '403': *29 '304': *37 @@ -100282,7 +100197,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *132 + - *138 responses: '204': description: Response @@ -100308,7 +100223,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *132 + - *138 responses: '204': description: Response @@ -100342,12 +100257,12 @@ paths: application/json: schema: anyOf: - - *214 + - *220 - type: object properties: {} additionalProperties: false examples: - default: *215 + default: *221 '204': description: Response when there are no restrictions x-github: @@ -100371,7 +100286,7 @@ paths: required: true content: application/json: - schema: *520 + schema: *524 examples: default: value: @@ -100382,7 +100297,7 @@ paths: description: Response content: application/json: - schema: *214 + schema: *220 examples: default: value: @@ -100463,7 +100378,7 @@ paths: - closed - all default: open - - *222 + - *228 - name: sort description: What to sort results by. in: query @@ -100475,8 +100390,8 @@ paths: - updated - comments default: created - - *48 - - *72 + - *52 + - *76 - *17 - *19 responses: @@ -100486,11 +100401,11 @@ paths: application/json: schema: type: array - items: *82 + items: *86 examples: - default: *223 + default: *229 headers: - Link: *54 + Link: *58 '404': *6 '304': *37 x-github: @@ -100521,7 +100436,7 @@ paths: application/json: schema: type: array - items: &675 + items: &677 title: Key description: Key type: object @@ -100572,7 +100487,7 @@ paths: verified: false read_only: false headers: - Link: *54 + Link: *58 '304': *37 '404': *6 '403': *29 @@ -100622,9 +100537,9 @@ paths: description: Response content: application/json: - schema: *675 + schema: *677 examples: - default: &676 + default: &678 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -100657,15 +100572,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *550 + - *554 responses: '200': description: Response content: application/json: - schema: *675 + schema: *677 examples: - default: *676 + default: *678 '404': *6 '304': *37 '403': *29 @@ -100688,7 +100603,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *550 + - *554 responses: '204': description: Response @@ -100721,7 +100636,7 @@ paths: application/json: schema: type: array - items: &677 + items: &679 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -100778,7 +100693,7 @@ paths: - id - type - login - plan: *86 + plan: *90 required: - billing_cycle - next_billing_date @@ -100789,7 +100704,7 @@ paths: - account - plan examples: - default: &678 + default: &680 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -100822,7 +100737,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *54 + Link: *58 '304': *37 '401': *25 '404': *6 @@ -100851,11 +100766,11 @@ paths: application/json: schema: type: array - items: *677 + items: *679 examples: - default: *678 + default: *680 headers: - Link: *54 + Link: *58 '304': *37 '401': *25 x-github: @@ -100893,7 +100808,7 @@ paths: application/json: schema: type: array - items: *228 + items: *234 examples: default: value: @@ -100970,7 +100885,7 @@ paths: type: User site_admin: false headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -100995,13 +100910,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: *228 + schema: *234 examples: default: value: @@ -101059,7 +100974,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *63 + - *67 requestBody: required: true content: @@ -101084,7 +100999,7 @@ paths: description: Response content: application/json: - schema: *228 + schema: *234 examples: default: value: @@ -101152,7 +101067,7 @@ paths: application/json: schema: type: array - items: *230 + items: *236 examples: default: value: @@ -101305,7 +101220,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -101405,7 +101320,7 @@ paths: description: Response content: application/json: - schema: *230 + schema: *236 examples: default: value: @@ -101585,7 +101500,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *231 + - *237 - name: exclude in: query required: false @@ -101598,7 +101513,7 @@ paths: description: Response content: application/json: - schema: *230 + schema: *236 examples: default: value: @@ -101792,7 +101707,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *231 + - *237 responses: '302': description: Response @@ -101818,7 +101733,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *231 + - *237 responses: '204': description: Response @@ -101847,8 +101762,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *231 - - *679 + - *237 + - *681 responses: '204': description: Response @@ -101872,7 +101787,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *231 + - *237 - *17 - *19 responses: @@ -101882,11 +101797,11 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: *243 + default: *249 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -101919,11 +101834,11 @@ paths: application/json: schema: type: array - items: *61 + items: *65 examples: - default: *99 + default: *103 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -101963,7 +101878,7 @@ paths: - docker - nuget - container - - *680 + - *682 - *19 - *17 responses: @@ -101973,10 +101888,10 @@ paths: application/json: schema: type: array - items: *237 + items: *243 examples: - default: *681 - '400': *682 + default: *683 + '400': *684 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -101996,16 +101911,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *239 - - *240 + - *245 + - *246 responses: '200': description: Response content: application/json: - schema: *237 + schema: *243 examples: - default: &698 + default: &700 value: id: 40201 name: octo-name @@ -102118,8 +102033,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *239 - - *240 + - *245 + - *246 responses: '204': description: Response @@ -102149,8 +102064,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *239 - - *240 + - *245 + - *246 - name: token description: package token schema: @@ -102182,8 +102097,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: - - *239 - - *240 + - *245 + - *246 - *19 - *17 - name: state @@ -102203,7 +102118,7 @@ paths: application/json: schema: type: array - items: *241 + items: *247 examples: default: value: @@ -102252,15 +102167,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *239 - - *240 - - *242 + - *245 + - *246 + - *248 responses: '200': description: Response content: application/json: - schema: *241 + schema: *247 examples: default: value: @@ -102296,9 +102211,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *239 - - *240 - - *242 + - *245 + - *246 + - *248 responses: '204': description: Response @@ -102328,9 +102243,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *239 - - *240 - - *242 + - *245 + - *246 + - *248 responses: '204': description: Response @@ -102367,11 +102282,11 @@ paths: application/json: schema: type: array - items: *671 + items: *673 examples: - default: *683 + default: *685 headers: - Link: *54 + Link: *58 '304': *37 '404': *6 '403': *29 @@ -102480,9 +102395,9 @@ paths: application/json: schema: type: array - items: *66 + items: *70 examples: - default: &690 + default: &692 summary: Default response value: - id: 1296269 @@ -102603,7 +102518,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *54 + Link: *58 '422': *15 '304': *37 '403': *29 @@ -102786,9 +102701,9 @@ paths: description: Response content: application/json: - schema: *333 + schema: *335 examples: - default: *335 + default: *337 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -102826,11 +102741,11 @@ paths: application/json: schema: type: array - items: *522 + items: *526 examples: - default: *684 + default: *686 headers: - Link: *54 + Link: *58 '304': *37 '404': *6 '403': *29 @@ -102851,12 +102766,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *218 + - *224 responses: '204': description: Response '403': *29 - '409': *47 + '409': *51 '404': *6 '304': *37 x-github: @@ -102874,11 +102789,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *218 + - *224 responses: '204': description: Response - '409': *47 + '409': *51 '304': *37 '404': *6 '403': *29 @@ -102907,7 +102822,7 @@ paths: application/json: schema: type: array - items: &685 + items: &687 title: Social account description: Social media account type: object @@ -102922,12 +102837,12 @@ paths: - provider - url examples: - default: &686 + default: &688 value: - provider: twitter url: https://twitter.com/github headers: - Link: *54 + Link: *58 '304': *37 '404': *6 '403': *29 @@ -102984,9 +102899,9 @@ paths: application/json: schema: type: array - items: *685 + items: *687 examples: - default: *686 + default: *688 '422': *15 '304': *37 '404': *6 @@ -103073,7 +102988,7 @@ paths: application/json: schema: type: array - items: &687 + items: &689 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -103093,7 +103008,7 @@ paths: - title - created_at examples: - default: &706 + default: &717 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -103104,7 +103019,7 @@ paths: title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' headers: - Link: *54 + Link: *58 '304': *37 '404': *6 '403': *29 @@ -103157,9 +103072,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *689 examples: - default: &688 + default: &690 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -103189,7 +103104,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: - - &689 + - &691 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -103201,9 +103116,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *689 examples: - default: *688 + default: *690 '404': *6 '304': *37 '403': *29 @@ -103226,7 +103141,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: - - *689 + - *691 responses: '204': description: Response @@ -103255,7 +103170,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &707 + - &718 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 @@ -103268,7 +103183,7 @@ paths: - created - updated default: created - - *48 + - *52 - *17 - *19 responses: @@ -103278,13 +103193,13 @@ paths: application/json: schema: type: array - items: *66 + items: *70 examples: - default-response: *690 + default-response: *692 application/vnd.github.v3.star+json: schema: type: array - items: &708 + items: &719 title: Starred Repository description: Starred Repository type: object @@ -103292,7 +103207,7 @@ paths: starred_at: type: string format: date-time - repo: *66 + repo: *70 required: - starred_at - repo @@ -103420,7 +103335,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -103440,8 +103355,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: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response if this repository is starred by you @@ -103469,8 +103384,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -103494,8 +103409,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -103528,11 +103443,11 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: *243 + default: *249 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -103567,7 +103482,7 @@ paths: application/json: schema: type: array - items: *312 + items: *319 examples: default: value: @@ -103618,7 +103533,7 @@ paths: updated_at: '2017-08-17T12:37:15Z' type: Organization headers: - Link: *54 + Link: *58 '304': *37 '404': *6 '403': *29 @@ -103645,7 +103560,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *88 + - *92 responses: '200': description: Response @@ -103653,10 +103568,10 @@ paths: application/json: schema: oneOf: - - *664 - - *663 + - *666 + - *665 examples: - default-response: &692 + default-response: &694 summary: Default response value: login: octocat @@ -103691,7 +103606,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &693 + response-with-git-hub-plan-information: &695 summary: Response with GitHub plan information value: login: octocat @@ -103754,7 +103669,7 @@ paths: required: true schema: type: string - - *255 + - *261 requestBody: required: true description: Details of the draft item to create in the project. @@ -103788,9 +103703,9 @@ paths: description: Response content: application/json: - schema: *261 + schema: *267 examples: - draft_issue: *262 + draft_issue: *268 '304': *37 '403': *29 '401': *25 @@ -103813,7 +103728,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *691 + - *693 - *17 responses: '200': @@ -103824,7 +103739,7 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: Link: example: ; rel="next" @@ -103854,7 +103769,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *59 + - *63 responses: '200': description: Response @@ -103862,11 +103777,11 @@ paths: application/json: schema: oneOf: - - *664 - - *663 + - *666 + - *665 examples: - default-response: *692 - response-with-git-hub-plan-information: *693 + default-response: *694 + response-with-git-hub-plan-information: *695 '404': *6 x-github: githubCloudOnly: false @@ -103890,9 +103805,9 @@ paths: url: https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *40 - - *41 - - *59 + - *45 + - *46 + - *63 requestBody: required: true content: @@ -103916,8 +103831,8 @@ paths: required: - subject_digests examples: - default: *694 - withPredicateType: *695 + default: *696 + withPredicateType: *697 responses: '200': description: Response @@ -103970,7 +103885,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *696 + default: *698 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103988,7 +103903,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk parameters: - - *59 + - *63 requestBody: required: true content: @@ -104053,7 +103968,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *59 + - *63 - name: subject_digest description: Subject Digest in: path @@ -104084,7 +103999,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-id parameters: - - *59 + - *63 - name: attestation_id description: Attestation ID in: path @@ -104120,9 +104035,9 @@ paths: url: https://docs.github.com/rest/users/attestations#list-attestations parameters: - *17 - - *40 - - *41 - - *59 + - *45 + - *46 + - *63 - name: subject_digest description: Subject Digest in: path @@ -104175,12 +104090,12 @@ paths: initiator: type: string examples: - default: *389 + default: *393 '201': description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -104206,7 +104121,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: - - *59 + - *63 responses: '200': description: Response @@ -104214,9 +104129,9 @@ paths: application/json: schema: type: array - items: *237 + items: *243 examples: - default: *681 + default: *683 '403': *29 '401': *25 x-github: @@ -104239,7 +104154,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -104249,7 +104164,7 @@ paths: application/json: schema: type: array - items: *94 + items: *98 examples: default: value: @@ -104311,8 +104226,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *59 - *63 + - *67 - *17 - *19 responses: @@ -104322,7 +104237,7 @@ paths: application/json: schema: type: array - items: *94 + items: *98 examples: default: value: @@ -104399,7 +104314,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -104409,7 +104324,7 @@ paths: application/json: schema: type: array - items: *94 + items: *98 examples: default: value: @@ -104467,7 +104382,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -104479,9 +104394,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104498,7 +104413,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *59 + - *63 - *17 - *19 responses: @@ -104510,9 +104425,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104529,7 +104444,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *59 + - *63 - name: target_user in: path required: true @@ -104556,8 +104471,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *59 - - *72 + - *63 + - *76 - *17 - *19 responses: @@ -104567,11 +104482,11 @@ paths: application/json: schema: type: array - items: *73 + items: *77 examples: - default: *74 + default: *78 headers: - Link: *54 + Link: *58 '422': *15 x-github: githubCloudOnly: false @@ -104590,7 +104505,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -104600,11 +104515,11 @@ paths: application/json: schema: type: array - items: *672 + items: *674 examples: - default: *697 + default: *699 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104626,7 +104541,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *59 + - *63 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -104698,7 +104613,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *59 + - *63 responses: '200': description: Response @@ -104706,7 +104621,7 @@ paths: application/json: schema: *22 examples: - default: *519 + default: *523 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104724,7 +104639,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -104759,7 +104674,7 @@ paths: - id: 1 key: ssh-rsa AAA... headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104779,7 +104694,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -104789,11 +104704,11 @@ paths: application/json: schema: type: array - items: *61 + items: *65 examples: - default: *99 + default: *103 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104830,8 +104745,8 @@ paths: - docker - nuget - container - - *680 - - *59 + - *682 + - *63 - *19 - *17 responses: @@ -104841,12 +104756,12 @@ paths: application/json: schema: type: array - items: *237 + items: *243 examples: - default: *681 + default: *683 '403': *29 '401': *25 - '400': *682 + '400': *684 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104866,17 +104781,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *239 - - *240 - - *59 + - *245 + - *246 + - *63 responses: '200': description: Response content: application/json: - schema: *237 + schema: *243 examples: - default: *698 + default: *700 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104897,9 +104812,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *239 - - *240 - - *59 + - *245 + - *246 + - *63 responses: '204': description: Response @@ -104931,9 +104846,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *239 - - *240 - - *59 + - *245 + - *246 + - *63 - name: token description: package token schema: @@ -104965,9 +104880,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: - - *239 - - *240 - - *59 + - *245 + - *246 + - *63 responses: '200': description: Response @@ -104975,7 +104890,7 @@ paths: application/json: schema: type: array - items: *241 + items: *247 examples: default: value: @@ -105033,16 +104948,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *239 - - *240 - - *242 - - *59 + - *245 + - *246 + - *248 + - *63 responses: '200': description: Response content: application/json: - schema: *241 + schema: *247 examples: default: value: @@ -105077,10 +104992,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *239 - - *240 - - *59 - - *242 + - *245 + - *246 + - *63 + - *248 responses: '204': description: Response @@ -105112,10 +105027,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *239 - - *240 - - *59 - - *242 + - *245 + - *246 + - *63 + - *248 responses: '204': description: Response @@ -105139,15 +105054,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-user parameters: - - *59 + - *63 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *40 - - *41 + - *45 + - *46 - *17 responses: '200': @@ -105156,11 +105071,11 @@ paths: application/json: schema: type: array - items: *253 + items: *259 examples: - default: *254 + default: *260 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -105180,18 +105095,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *255 - - *59 + - *261 + - *63 responses: '200': description: Response content: application/json: - schema: *253 + schema: *259 examples: - default: *254 + default: *260 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -105211,11 +105126,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *255 - - *59 + - *261 + - *63 - *17 - - *40 - - *41 + - *45 + - *46 responses: '200': description: Response @@ -105223,14 +105138,124 @@ paths: application/json: schema: type: array - items: *259 + items: *265 examples: - default: *699 + default: *701 headers: - Link: *54 + Link: *58 + '304': *37 + '403': *29 + '401': *25 + x-github: + githubCloudOnly: false + 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: + - *63 + - *261 + 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: *702 + 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: *703 + 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: *704 + iteration_field: *705 + responses: + '201': + description: Response + content: + application/json: + schema: *265 + examples: + text_field: *706 + number_field: *707 + date_field: *708 + single_select_field: *709 + iteration_field: *710 '304': *37 '403': *29 '401': *25 + '422': *15 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105247,19 +105272,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *255 - - *700 - - *59 + - *261 + - *711 + - *63 responses: '200': description: Response content: application/json: - schema: *259 + schema: *265 examples: - default: *701 + default: *712 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -105280,10 +105305,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *255 - - *59 - - *40 - - *41 + - *261 + - *63 + - *45 + - *46 - *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) @@ -105313,11 +105338,11 @@ paths: application/json: schema: type: array - items: *263 + items: *269 examples: - default: *264 + default: *270 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -105336,8 +105361,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - - *59 - - *255 + - *63 + - *261 requestBody: required: true description: Details of the item to add to the project. @@ -105374,10 +105399,10 @@ paths: description: Response content: application/json: - schema: *261 + schema: *267 examples: - issue: *262 - pull_request: *262 + issue: *268 + pull_request: *268 '304': *37 '403': *29 '401': *25 @@ -105397,9 +105422,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *255 - - *59 - - *265 + - *261 + - *63 + - *271 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -105419,11 +105444,11 @@ paths: description: Response content: application/json: - schema: *263 + schema: *269 examples: - default: *264 + default: *270 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -105442,9 +105467,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *255 - - *59 - - *265 + - *261 + - *63 + - *271 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -105514,13 +105539,13 @@ paths: description: Response content: application/json: - schema: *263 + schema: *269 examples: - text_field: *264 - number_field: *264 - date_field: *264 - single_select_field: *264 - iteration_field: *264 + text_field: *270 + number_field: *270 + date_field: *270 + single_select_field: *270 + iteration_field: *270 '401': *25 '403': *29 '404': *6 @@ -105540,9 +105565,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *255 - - *59 - - *265 + - *261 + - *63 + - *271 responses: '204': description: Response @@ -105569,7 +105594,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -105579,7 +105604,7 @@ paths: application/json: schema: type: array - items: *94 + items: *98 examples: default: value: @@ -105644,7 +105669,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -105654,7 +105679,7 @@ paths: application/json: schema: type: array - items: *94 + items: *98 examples: default: value: @@ -105717,7 +105742,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *59 + - *63 - name: type description: Limit results to repositories of the specified type. in: query @@ -105760,11 +105785,11 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: *243 + default: *249 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105784,12 +105809,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-a-user parameters: - - *59 - - *106 - - *108 - - *107 - - *702 - - *109 + - *63 + - *112 + - *114 + - *113 + - *713 + - *115 responses: '200': description: Response when getting a billing premium request usage report @@ -105896,8 +105921,8 @@ paths: '400': *14 '403': *29 '404': *6 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105917,10 +105942,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-a-user parameters: - - *59 - - *106 - - *703 - - *107 + - *63 + - *112 + - *714 + - *113 responses: '200': description: Response when getting a billing usage report @@ -105990,8 +106015,8 @@ paths: repositoryName: user/example '400': *14 '403': *29 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106014,13 +106039,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-a-user parameters: - - *59 - - *106 - - *108 - - *107 - - *704 - - *109 - - *705 + - *63 + - *112 + - *114 + - *113 + - *715 + - *115 + - *716 responses: '200': description: Response when getting a billing usage summary @@ -106125,8 +106150,8 @@ paths: '400': *14 '403': *29 '404': *6 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106144,7 +106169,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -106154,11 +106179,11 @@ paths: application/json: schema: type: array - items: *685 + items: *687 examples: - default: *686 + default: *688 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106176,7 +106201,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -106186,11 +106211,11 @@ paths: application/json: schema: type: array - items: *687 + items: *689 examples: - default: *706 + default: *717 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106212,9 +106237,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *59 - - *707 - - *48 + - *63 + - *718 + - *52 - *17 - *19 responses: @@ -106225,13 +106250,13 @@ paths: schema: anyOf: - type: array - items: *708 + items: *719 - type: array - items: *66 + items: *70 examples: - default-response: *690 + default-response: *692 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106248,7 +106273,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -106258,11 +106283,11 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: *243 + default: *249 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106388,7 +106413,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &709 + enterprise: &720 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -106446,7 +106471,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &710 + installation: &721 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -106465,7 +106490,7 @@ x-webhooks: required: - id - node_id - organization: &711 + organization: &722 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -106525,13 +106550,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &712 + repository: &723 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &742 + properties: &753 id: description: Unique identifier of the repository example: 42 @@ -106551,8 +106576,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *83 - required: *84 + properties: *87 + required: *88 nullable: true organization: title: Simple User @@ -107214,7 +107239,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &743 + required: &754 - archive_url - assignees_url - blobs_url @@ -107365,10 +107390,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -107444,11 +107469,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - rule: &713 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + rule: &724 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) @@ -107671,11 +107696,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - rule: *713 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + rule: *724 sender: *4 required: - action @@ -107858,11 +107883,11 @@ x-webhooks: - everyone required: - from - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - rule: *713 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + rule: *724 sender: *4 required: - action @@ -107946,7 +107971,7 @@ x-webhooks: type: string enum: - completed - check_run: &715 + check_run: &726 title: CheckRun description: A check performed on the code of a given code change type: object @@ -107999,8 +108024,8 @@ x-webhooks: type: string pull_requests: type: array - items: *406 - repository: *143 + items: *410 + repository: *149 status: example: completed type: string @@ -108037,7 +108062,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *714 + deployment: *725 details_url: example: https://example.com type: string @@ -108087,7 +108112,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *406 + items: *410 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -108122,10 +108147,10 @@ x-webhooks: - output - app - pull_requests - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 sender: *4 required: - check_run @@ -108518,11 +108543,11 @@ x-webhooks: type: string enum: - created - check_run: *715 - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + check_run: *726 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 sender: *4 required: - check_run @@ -108918,11 +108943,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *715 - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + check_run: *726 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 requested_action: description: The action requested by the user. type: object @@ -109327,11 +109352,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *715 - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + check_run: *726 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 sender: *4 required: - check_run @@ -110308,10 +110333,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -110584,6 +110609,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -110996,10 +111026,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -111267,6 +111297,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -111678,10 +111713,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -111847,7 +111882,7 @@ x-webhooks: required: - login - id - dismissed_comment: *422 + dismissed_comment: *426 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -111992,20 +112027,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &716 + commit_oid: &727 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: *709 - installation: *710 - organization: *711 - ref: &717 + enterprise: *720 + installation: *721 + organization: *722 + ref: &728 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: *712 + repository: *723 sender: *4 required: - action @@ -112170,7 +112205,7 @@ x-webhooks: required: - login - id - dismissed_comment: *422 + dismissed_comment: *426 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -112400,12 +112435,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -112500,7 +112535,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *422 + dismissed_comment: *426 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -112671,12 +112706,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -112842,7 +112877,7 @@ x-webhooks: required: - login - id - dismissed_comment: *422 + dismissed_comment: *426 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -113008,12 +113043,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -113113,7 +113148,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *422 + dismissed_comment: *426 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -113281,16 +113316,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *712 + repository: *723 sender: *4 required: - action @@ -113387,7 +113422,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *422 + dismissed_comment: *426 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -113527,12 +113562,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -113789,10 +113824,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -113872,18 +113907,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *711 - pusher_type: &718 + organization: *722 + pusher_type: &729 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &719 + ref: &730 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -113893,7 +113928,7 @@ x-webhooks: enum: - tag - branch - repository: *712 + repository: *723 sender: *4 required: - ref @@ -113975,10 +114010,10 @@ x-webhooks: type: string enum: - created - definition: *266 - enterprise: *709 - installation: *710 - organization: *711 + definition: *272 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -114063,9 +114098,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -114142,10 +114177,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *266 - enterprise: *709 - installation: *710 - organization: *711 + definition: *272 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -114222,10 +114257,10 @@ x-webhooks: type: string enum: - updated - definition: *266 - enterprise: *709 - installation: *710 - organization: *711 + definition: *272 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -114302,19 +114337,19 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - repository: *712 - organization: *711 + enterprise: *720 + installation: *721 + repository: *723 + organization: *722 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *102 + items: *108 old_property_values: type: array description: The old custom property values for the repository. - items: *102 + items: *108 required: - action - repository @@ -114390,18 +114425,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - pusher_type: *718 - ref: *719 + enterprise: *720 + installation: *721 + organization: *722 + pusher_type: *729 + ref: *730 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *712 + repository: *723 sender: *4 required: - ref @@ -114485,11 +114520,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *482 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -114573,11 +114608,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *482 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -114661,11 +114696,11 @@ x-webhooks: type: string enum: - created - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *482 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -114747,11 +114782,11 @@ x-webhooks: type: string enum: - dismissed - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *482 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -114833,11 +114868,11 @@ x-webhooks: type: string enum: - fixed - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *482 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -114920,11 +114955,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *482 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -115006,11 +115041,11 @@ x-webhooks: type: string enum: - reopened - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *482 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -115087,9 +115122,9 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - key: &720 + enterprise: *720 + installation: *721 + key: &731 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -115125,8 +115160,8 @@ x-webhooks: - verified - created_at - read_only - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -115203,11 +115238,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - key: *720 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + key: *731 + organization: *722 + repository: *723 sender: *4 required: - action @@ -115768,12 +115803,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: &724 + workflow: &735 title: Workflow type: object nullable: true @@ -116499,13 +116534,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *484 + deployment: *488 pull_requests: type: array - items: *571 - repository: *712 - organization: *711 - installation: *710 + items: *575 + repository: *723 + organization: *722 + installation: *721 sender: *4 responses: '200': @@ -116576,7 +116611,7 @@ x-webhooks: type: string enum: - approved - approver: &721 + approver: &732 type: object properties: avatar_url: @@ -116619,11 +116654,11 @@ x-webhooks: type: string comment: type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - reviewers: &722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + reviewers: &733 type: array items: type: object @@ -116702,7 +116737,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &723 + workflow_job_run: &734 type: object properties: conclusion: @@ -117433,18 +117468,18 @@ x-webhooks: type: string enum: - rejected - approver: *721 + approver: *732 comment: type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - reviewers: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + reviewers: *733 sender: *4 since: type: string - workflow_job_run: *723 + workflow_job_run: *734 workflow_job_runs: type: array items: @@ -118148,13 +118183,13 @@ x-webhooks: type: string enum: - requested - enterprise: *709 + enterprise: *720 environment: type: string - installation: *710 - organization: *711 - repository: *712 - requestor: &729 + installation: *721 + organization: *722 + repository: *723 + requestor: &740 title: User type: object nullable: true @@ -120053,12 +120088,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *724 + workflow: *735 workflow_run: title: Deployment Workflow Run type: object @@ -120738,7 +120773,7 @@ x-webhooks: type: string enum: - answered - answer: &727 + answer: &738 type: object properties: author_association: @@ -120895,7 +120930,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &725 + discussion: &736 title: Discussion description: A Discussion in a repository. type: object @@ -121181,7 +121216,7 @@ x-webhooks: - id labels: type: array - items: *533 + items: *537 required: - repository_url - category @@ -121203,10 +121238,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -121333,11 +121368,11 @@ x-webhooks: - from required: - category - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -121420,11 +121455,11 @@ x-webhooks: type: string enum: - closed - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -121506,7 +121541,7 @@ x-webhooks: type: string enum: - created - comment: &726 + comment: &737 type: object properties: author_association: @@ -121663,11 +121698,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -121750,12 +121785,12 @@ x-webhooks: type: string enum: - deleted - comment: *726 - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + comment: *737 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -121850,12 +121885,12 @@ x-webhooks: - from required: - body - comment: *726 - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + comment: *737 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -121939,11 +121974,11 @@ x-webhooks: type: string enum: - created - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122025,11 +122060,11 @@ x-webhooks: type: string enum: - deleted - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122129,11 +122164,11 @@ x-webhooks: type: string required: - from - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122215,10 +122250,10 @@ x-webhooks: type: string enum: - labeled - discussion: *725 - enterprise: *709 - installation: *710 - label: &728 + discussion: *736 + enterprise: *720 + installation: *721 + label: &739 title: Label type: object properties: @@ -122250,8 +122285,8 @@ x-webhooks: - color - default - description - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122334,11 +122369,11 @@ x-webhooks: type: string enum: - locked - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122420,11 +122455,11 @@ x-webhooks: type: string enum: - pinned - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122506,11 +122541,11 @@ x-webhooks: type: string enum: - reopened - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122595,16 +122630,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *725 - new_repository: *712 + new_discussion: *736 + new_repository: *723 required: - new_discussion - new_repository - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122687,10 +122722,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *725 - old_answer: *727 - organization: *711 - repository: *712 + discussion: *736 + old_answer: *738 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122772,12 +122807,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *725 - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122860,11 +122895,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122946,11 +122981,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -123023,7 +123058,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *709 + enterprise: *720 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -123683,9 +123718,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *710 - organization: *711 - repository: *712 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - forkee @@ -123831,9 +123866,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 pages: description: The pages that were updated. type: array @@ -123870,7 +123905,7 @@ x-webhooks: - action - sha - html_url - repository: *712 + repository: *723 sender: *4 required: - pages @@ -123946,10 +123981,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 + enterprise: *720 installation: *22 - organization: *711 - repositories: &730 + organization: *722 + repositories: &741 description: An array of repository objects that the installation can access. type: array @@ -123975,8 +124010,8 @@ x-webhooks: - name - full_name - private - repository: *712 - requester: *729 + repository: *723 + requester: *740 sender: *4 required: - action @@ -124051,11 +124086,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 + enterprise: *720 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *722 + repositories: *741 + repository: *723 requester: nullable: true sender: *4 @@ -124131,11 +124166,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *709 + enterprise: *720 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *722 + repositories: *741 + repository: *723 requester: nullable: true sender: *4 @@ -124211,10 +124246,10 @@ x-webhooks: type: string enum: - added - enterprise: *709 + enterprise: *720 installation: *22 - organization: *711 - repositories_added: &731 + organization: *722 + repositories_added: &742 description: An array of repository objects, which were added to the installation. type: array @@ -124260,15 +124295,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *712 - repository_selection: &732 + repository: *723 + repository_selection: &743 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *729 + requester: *740 sender: *4 required: - action @@ -124347,10 +124382,10 @@ x-webhooks: type: string enum: - removed - enterprise: *709 + enterprise: *720 installation: *22 - organization: *711 - repositories_added: *731 + organization: *722 + repositories_added: *742 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -124377,9 +124412,9 @@ x-webhooks: - name - full_name - private - repository: *712 - repository_selection: *732 - requester: *729 + repository: *723 + repository_selection: *743 + requester: *740 sender: *4 required: - action @@ -124458,11 +124493,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *709 + enterprise: *720 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *722 + repositories: *741 + repository: *723 requester: nullable: true sender: *4 @@ -124640,10 +124675,10 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 target_type: type: string @@ -124722,11 +124757,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *709 + enterprise: *720 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *722 + repositories: *741 + repository: *723 requester: nullable: true sender: *4 @@ -124850,8 +124885,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 reactions: title: Reactions type: object @@ -124978,8 +125013,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -125773,8 +125808,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 state: description: State of the issue; either 'open' or 'closed' type: string @@ -125790,7 +125825,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -126123,8 +126158,8 @@ x-webhooks: - state - locked - assignee - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -126204,7 +126239,7 @@ x-webhooks: type: string enum: - deleted - comment: &733 + comment: &744 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -126369,8 +126404,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -127160,8 +127195,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 state: description: State of the issue; either 'open' or 'closed' type: string @@ -127177,7 +127212,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -127512,8 +127547,8 @@ x-webhooks: - state - locked - assignee - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -127593,7 +127628,7 @@ x-webhooks: type: string enum: - edited - changes: &762 + changes: &773 description: The changes to the comment. type: object properties: @@ -127605,9 +127640,9 @@ x-webhooks: type: string required: - from - comment: *733 - enterprise: *709 - installation: *710 + comment: *744 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128400,8 +128435,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128417,7 +128452,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -128750,8 +128785,8 @@ x-webhooks: - state - locked - assignee - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -128835,15 +128870,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *82 + blocked_issue: *86 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *82 - blocking_issue_repo: *66 - installation: *710 - organization: *711 - repository: *712 + blocking_issue: *86 + blocking_issue_repo: *70 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -128931,15 +128966,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *82 + blocked_issue: *86 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *82 - blocking_issue_repo: *66 - installation: *710 - organization: *711 - repository: *712 + blocking_issue: *86 + blocking_issue_repo: *70 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -129026,15 +129061,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *82 - blocked_issue_repo: *66 + blocked_issue: *86 + blocked_issue_repo: *70 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *82 - installation: *710 - organization: *711 - repository: *712 + blocking_issue: *86 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -129122,15 +129157,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *82 - blocked_issue_repo: *66 + blocked_issue: *86 + blocked_issue_repo: *70 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *82 - installation: *710 - organization: *711 - repository: *712 + blocking_issue: *86 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -129215,10 +129250,10 @@ x-webhooks: type: string enum: - assigned - assignee: *729 - enterprise: *709 - installation: *710 - issue: &736 + assignee: *740 + enterprise: *720 + installation: *721 + issue: &747 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -130007,11 +130042,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130027,7 +130062,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -130128,8 +130163,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -130209,8 +130244,8 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -131004,11 +131039,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131024,7 +131059,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -131260,8 +131295,8 @@ x-webhooks: required: - state - closed_at - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131340,8 +131375,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -132126,11 +132161,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132146,7 +132181,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -132246,8 +132281,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -132326,8 +132361,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -133134,11 +133169,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133154,7 +133189,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -133233,7 +133268,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &734 + milestone: &745 title: Milestone description: A collection of related issues and pull requests. type: object @@ -133371,8 +133406,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -133471,8 +133506,8 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134261,11 +134296,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134278,7 +134313,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *219 + type: *225 title: description: Title of the issue type: string @@ -134382,9 +134417,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *728 - organization: *711 - repository: *712 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -134464,8 +134499,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135253,11 +135288,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135270,7 +135305,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *219 + type: *225 title: description: Title of the issue type: string @@ -135374,9 +135409,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *728 - organization: *711 - repository: *712 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -135456,8 +135491,8 @@ x-webhooks: type: string enum: - locked - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136269,11 +136304,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136286,7 +136321,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *219 + type: *225 title: description: Title of the issue type: string @@ -136367,8 +136402,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -136447,8 +136482,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137254,11 +137289,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137274,7 +137309,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -137352,9 +137387,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *734 - organization: *711 - repository: *712 + milestone: *745 + organization: *722 + repository: *723 sender: *4 required: - action @@ -138222,11 +138257,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138319,7 +138354,7 @@ x-webhooks: required: - login - id - type: *219 + type: *225 required: - id - number @@ -138788,8 +138823,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139578,11 +139613,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139598,7 +139633,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -139698,8 +139733,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -139779,9 +139814,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *709 - installation: *710 - issue: &735 + enterprise: *720 + installation: *721 + issue: &746 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -140564,11 +140599,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140584,7 +140619,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -140684,8 +140719,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -140764,8 +140799,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141575,11 +141610,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141673,9 +141708,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *219 - organization: *711 - repository: *712 + type: *225 + organization: *722 + repository: *723 sender: *4 required: - action @@ -142541,11 +142576,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142561,7 +142596,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -143129,11 +143164,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *709 - installation: *710 - issue: *735 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + issue: *746 + organization: *722 + repository: *723 sender: *4 required: - action @@ -143213,12 +143248,12 @@ x-webhooks: type: string enum: - typed - enterprise: *709 - installation: *710 - issue: *736 - type: *219 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + issue: *747 + type: *225 + organization: *722 + repository: *723 sender: *4 required: - action @@ -143299,7 +143334,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &765 + assignee: &776 title: User type: object nullable: true @@ -143369,11 +143404,11 @@ x-webhooks: required: - login - id - enterprise: *709 - installation: *710 - issue: *736 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + issue: *747 + organization: *722 + repository: *723 sender: *4 required: - action @@ -143452,12 +143487,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *709 - installation: *710 - issue: *736 - label: *728 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + issue: *747 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -143537,8 +143572,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144348,11 +144383,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144368,7 +144403,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -144446,8 +144481,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -144527,11 +144562,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *709 - installation: *710 - issue: *735 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + issue: *746 + organization: *722 + repository: *723 sender: *4 required: - action @@ -144610,12 +144645,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *709 - installation: *710 - issue: *736 - type: *219 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + issue: *747 + type: *225 + organization: *722 + repository: *723 sender: *4 required: - action @@ -144695,11 +144730,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -144777,11 +144812,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -144891,11 +144926,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -144977,9 +145012,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: &737 + enterprise: *720 + installation: *721 + marketplace_purchase: &748 title: Marketplace Purchase type: object required: @@ -145062,8 +145097,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *711 - previous_marketplace_purchase: &738 + organization: *722 + previous_marketplace_purchase: &749 title: Marketplace Purchase type: object properties: @@ -145143,7 +145178,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *712 + repository: *723 sender: *4 required: - action @@ -145223,10 +145258,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: *737 - organization: *711 + enterprise: *720 + installation: *721 + marketplace_purchase: *748 + organization: *722 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -145309,7 +145344,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *712 + repository: *723 sender: *4 required: - action @@ -145391,10 +145426,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: *737 - organization: *711 + enterprise: *720 + installation: *721 + marketplace_purchase: *748 + organization: *722 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -145476,7 +145511,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *712 + repository: *723 sender: *4 required: - action @@ -145557,8 +145592,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 marketplace_purchase: title: Marketplace Purchase type: object @@ -145640,9 +145675,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *711 - previous_marketplace_purchase: *738 - repository: *712 + organization: *722 + previous_marketplace_purchase: *749 + repository: *723 sender: *4 required: - action @@ -145722,12 +145757,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: *737 - organization: *711 - previous_marketplace_purchase: *738 - repository: *712 + enterprise: *720 + installation: *721 + marketplace_purchase: *748 + organization: *722 + previous_marketplace_purchase: *749 + repository: *723 sender: *4 required: - action @@ -145829,11 +145864,11 @@ x-webhooks: type: string required: - to - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 sender: *4 required: - action @@ -145933,11 +145968,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 sender: *4 required: - action @@ -146016,11 +146051,11 @@ x-webhooks: type: string enum: - removed - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 sender: *4 required: - action @@ -146098,11 +146133,11 @@ x-webhooks: type: string enum: - added - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 scope: description: The scope of the membership. Currently, can only be `team`. @@ -146178,7 +146213,7 @@ x-webhooks: required: - login - id - team: &739 + team: &750 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -146401,11 +146436,11 @@ x-webhooks: type: string enum: - removed - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 scope: description: The scope of the membership. Currently, can only be `team`. @@ -146482,7 +146517,7 @@ x-webhooks: required: - login - id - team: *739 + team: *750 required: - action - scope @@ -146564,8 +146599,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *710 - merge_group: &741 + installation: *721 + merge_group: &752 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -146584,15 +146619,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *740 + head_commit: *751 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -146678,10 +146713,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *710 - merge_group: *741 - organization: *711 - repository: *712 + installation: *721 + merge_group: *752 + organization: *722 + repository: *723 sender: *4 required: - action @@ -146754,7 +146789,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 + enterprise: *720 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -146863,16 +146898,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *710 - organization: *711 + installation: *721 + organization: *722 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *753 + required: *754 nullable: true sender: *4 required: @@ -146953,11 +146988,11 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 - milestone: *734 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + milestone: *745 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147036,9 +147071,9 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - milestone: &744 + enterprise: *720 + installation: *721 + milestone: &755 title: Milestone description: A collection of related issues and pull requests. type: object @@ -147175,8 +147210,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147255,11 +147290,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - milestone: *734 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + milestone: *745 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147369,11 +147404,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - milestone: *734 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + milestone: *745 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147453,11 +147488,11 @@ x-webhooks: type: string enum: - opened - enterprise: *709 - installation: *710 - milestone: *744 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + milestone: *755 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147536,11 +147571,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *729 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + blocked_user: *740 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147619,11 +147654,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *729 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + blocked_user: *740 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147702,9 +147737,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - membership: &745 + enterprise: *720 + installation: *721 + membership: &756 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -147811,8 +147846,8 @@ x-webhooks: - role - organization_url - user - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147890,11 +147925,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *709 - installation: *710 - membership: *745 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + membership: *756 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147973,8 +148008,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -148090,10 +148125,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 - user: *729 + user: *740 required: - action - invitation @@ -148171,11 +148206,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *709 - installation: *710 - membership: *745 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + membership: *756 + organization: *722 + repository: *723 sender: *4 required: - action @@ -148262,11 +148297,11 @@ x-webhooks: properties: from: type: string - enterprise: *709 - installation: *710 - membership: *745 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + membership: *756 + organization: *722 + repository: *723 sender: *4 required: - action @@ -148342,9 +148377,9 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 package: description: Information about the package. type: object @@ -148843,7 +148878,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &746 + items: &757 title: Ruby Gems metadata type: object properties: @@ -148938,7 +148973,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *723 sender: *4 required: - action @@ -149014,9 +149049,9 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 package: description: Information about the package. type: object @@ -149369,7 +149404,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *746 + items: *757 source_url: type: string format: uri @@ -149439,7 +149474,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *723 sender: *4 required: - action @@ -149616,12 +149651,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *709 + enterprise: *720 id: type: integer - installation: *710 - organization: *711 - repository: *712 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - id @@ -149698,7 +149733,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &747 + personal_access_token_request: &758 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -149844,10 +149879,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *709 - organization: *711 + enterprise: *720 + organization: *722 sender: *4 - installation: *710 + installation: *721 required: - action - personal_access_token_request @@ -149924,11 +149959,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *747 - enterprise: *709 - organization: *711 + personal_access_token_request: *758 + enterprise: *720 + organization: *722 sender: *4 - installation: *710 + installation: *721 required: - action - personal_access_token_request @@ -150004,11 +150039,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *747 - enterprise: *709 - organization: *711 + personal_access_token_request: *758 + enterprise: *720 + organization: *722 sender: *4 - installation: *710 + installation: *721 required: - action - personal_access_token_request @@ -150083,11 +150118,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *747 - organization: *711 - enterprise: *709 + personal_access_token_request: *758 + organization: *722 + enterprise: *720 sender: *4 - installation: *710 + installation: *721 required: - action - personal_access_token_request @@ -150192,7 +150227,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *748 + last_response: *759 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -150224,8 +150259,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 zen: description: Random string of GitHub zen. @@ -150470,10 +150505,10 @@ x-webhooks: - from required: - note - enterprise: *709 - installation: *710 - organization: *711 - project_card: &749 + enterprise: *720 + installation: *721 + organization: *722 + project_card: &760 title: Project Card type: object properties: @@ -150592,7 +150627,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *712 + repository: *723 sender: *4 required: - action @@ -150673,11 +150708,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - project_card: *749 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + project_card: *760 + repository: *723 sender: *4 required: - action @@ -150757,9 +150792,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 project_card: title: Project Card type: object @@ -150887,8 +150922,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *753 + required: *754 nullable: true sender: *4 required: @@ -150982,11 +151017,11 @@ x-webhooks: - from required: - note - enterprise: *709 - installation: *710 - organization: *711 - project_card: *749 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + project_card: *760 + repository: *723 sender: *4 required: - action @@ -151080,9 +151115,9 @@ x-webhooks: - from required: - column_id - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 project_card: allOf: - title: Project Card @@ -151272,7 +151307,7 @@ x-webhooks: type: string required: - after_id - repository: *712 + repository: *723 sender: *4 required: - action @@ -151352,10 +151387,10 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 - organization: *711 - project: &751 + enterprise: *720 + installation: *721 + organization: *722 + project: &762 title: Project type: object properties: @@ -151479,7 +151514,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *712 + repository: *723 sender: *4 required: - action @@ -151559,10 +151594,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - project_column: &750 + enterprise: *720 + installation: *721 + organization: *722 + project_column: &761 title: Project Column type: object properties: @@ -151601,7 +151636,7 @@ x-webhooks: - name - created_at - updated_at - repository: *712 + repository: *723 sender: *4 required: - action @@ -151680,18 +151715,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - project_column: *750 + enterprise: *720 + installation: *721 + organization: *722 + project_column: *761 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *753 + required: *754 nullable: true sender: *4 required: @@ -151781,11 +151816,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - project_column: *750 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + project_column: *761 + repository: *723 sender: *4 required: - action @@ -151865,11 +151900,11 @@ x-webhooks: type: string enum: - moved - enterprise: *709 - installation: *710 - organization: *711 - project_column: *750 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + project_column: *761 + repository: *723 sender: *4 required: - action @@ -151949,11 +151984,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - project: *751 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + project: *762 + repository: *723 sender: *4 required: - action @@ -152033,18 +152068,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - project: *751 + enterprise: *720 + installation: *721 + organization: *722 + project: *762 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *753 + required: *754 nullable: true sender: *4 required: @@ -152146,11 +152181,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - project: *751 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + project: *762 + repository: *723 sender: *4 required: - action @@ -152229,11 +152264,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *709 - installation: *710 - organization: *711 - project: *751 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + project: *762 + repository: *723 sender: *4 required: - action @@ -152314,9 +152349,9 @@ x-webhooks: type: string enum: - closed - installation: *710 - organization: *711 - projects_v2: *253 + installation: *721 + organization: *722 + projects_v2: *259 sender: *4 required: - action @@ -152397,9 +152432,9 @@ x-webhooks: type: string enum: - created - installation: *710 - organization: *711 - projects_v2: *253 + installation: *721 + organization: *722 + projects_v2: *259 sender: *4 required: - action @@ -152480,9 +152515,9 @@ x-webhooks: type: string enum: - deleted - installation: *710 - organization: *711 - projects_v2: *253 + installation: *721 + organization: *722 + projects_v2: *259 sender: *4 required: - action @@ -152599,9 +152634,9 @@ x-webhooks: type: string to: type: string - installation: *710 - organization: *711 - projects_v2: *253 + installation: *721 + organization: *722 + projects_v2: *259 sender: *4 required: - action @@ -152684,7 +152719,7 @@ x-webhooks: type: string enum: - archived - changes: &755 + changes: &766 type: object properties: archived_at: @@ -152698,9 +152733,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *710 - organization: *711 - projects_v2_item: &752 + installation: *721 + organization: *722 + projects_v2_item: &763 title: Projects v2 Item description: An item belonging to a project type: object @@ -152718,7 +152753,7 @@ x-webhooks: type: string description: The node ID of the content represented by this item. - content_type: *260 + content_type: *266 creator: *4 created_at: type: string @@ -152835,9 +152870,9 @@ x-webhooks: nullable: true to: type: string - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *721 + organization: *722 + projects_v2_item: *763 sender: *4 required: - action @@ -152919,9 +152954,9 @@ x-webhooks: type: string enum: - created - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *721 + organization: *722 + projects_v2_item: *763 sender: *4 required: - action @@ -153002,9 +153037,9 @@ x-webhooks: type: string enum: - deleted - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *721 + organization: *722 + projects_v2_item: *763 sender: *4 required: - action @@ -153110,7 +153145,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &753 + - &764 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -153132,7 +153167,7 @@ x-webhooks: required: - id - name - - &754 + - &765 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -153166,8 +153201,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *753 - - *754 + - *764 + - *765 required: - field_value - type: object @@ -153183,9 +153218,9 @@ x-webhooks: nullable: true required: - body - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *721 + organization: *722 + projects_v2_item: *763 sender: *4 required: - action @@ -153280,9 +153315,9 @@ x-webhooks: to: type: string nullable: true - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *721 + organization: *722 + projects_v2_item: *763 sender: *4 required: - action @@ -153365,10 +153400,10 @@ x-webhooks: type: string enum: - restored - changes: *755 - installation: *710 - organization: *711 - projects_v2_item: *752 + changes: *766 + installation: *721 + organization: *722 + projects_v2_item: *763 sender: *4 required: - action @@ -153450,9 +153485,9 @@ x-webhooks: type: string enum: - reopened - installation: *710 - organization: *711 - projects_v2: *253 + installation: *721 + organization: *722 + projects_v2: *259 sender: *4 required: - action @@ -153533,14 +153568,14 @@ x-webhooks: type: string enum: - created - installation: *710 - organization: *711 - projects_v2_status_update: &758 + installation: *721 + organization: *722 + projects_v2_status_update: &769 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *756 - required: *757 + properties: *767 + required: *768 sender: *4 required: - action @@ -153621,9 +153656,9 @@ x-webhooks: type: string enum: - deleted - installation: *710 - organization: *711 - projects_v2_status_update: *758 + installation: *721 + organization: *722 + projects_v2_status_update: *769 sender: *4 required: - action @@ -153759,9 +153794,9 @@ x-webhooks: type: string format: date nullable: true - installation: *710 - organization: *711 - projects_v2_status_update: *758 + installation: *721 + organization: *722 + projects_v2_status_update: *769 sender: *4 required: - action @@ -153832,10 +153867,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - repository @@ -153912,13 +153947,13 @@ x-webhooks: type: string enum: - assigned - assignee: *729 - enterprise: *709 - installation: *710 - number: &759 + assignee: *740 + enterprise: *720 + installation: *721 + number: &770 description: The pull request number. type: integer - organization: *711 + organization: *722 pull_request: title: Pull Request type: object @@ -156201,7 +156236,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 sender: *4 required: - action @@ -156283,11 +156318,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 number: type: integer - organization: *711 + organization: *722 pull_request: title: Pull Request type: object @@ -158565,7 +158600,7 @@ x-webhooks: - draft reason: type: string - repository: *712 + repository: *723 sender: *4 required: - action @@ -158647,11 +158682,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 number: type: integer - organization: *711 + organization: *722 pull_request: title: Pull Request type: object @@ -160929,7 +160964,7 @@ x-webhooks: - draft reason: type: string - repository: *712 + repository: *723 sender: *4 required: - action @@ -161011,13 +161046,13 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: &760 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 + pull_request: &771 allOf: - - *571 + - *575 - type: object properties: allow_auto_merge: @@ -161079,7 +161114,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *712 + repository: *723 sender: *4 required: - action @@ -161160,12 +161195,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 + pull_request: *771 + repository: *723 sender: *4 required: - action @@ -161245,11 +161280,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *709 - milestone: *553 - number: *759 - organization: *711 - pull_request: &761 + enterprise: *720 + milestone: *557 + number: *770 + organization: *722 + pull_request: &772 title: Pull Request type: object properties: @@ -163512,7 +163547,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 sender: *4 required: - action @@ -163591,11 +163626,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 number: type: integer - organization: *711 + organization: *722 pull_request: title: Pull Request type: object @@ -165877,7 +165912,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *712 + repository: *723 sender: *4 required: - action @@ -166001,12 +166036,12 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 + pull_request: *771 + repository: *723 sender: *4 required: - action @@ -166086,11 +166121,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 number: type: integer - organization: *711 + organization: *722 pull_request: title: Pull Request type: object @@ -168357,7 +168392,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 sender: *4 required: - action @@ -168437,11 +168472,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *709 - installation: *710 - label: *728 - number: *759 - organization: *711 + enterprise: *720 + installation: *721 + label: *739 + number: *770 + organization: *722 pull_request: title: Pull Request type: object @@ -170723,7 +170758,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 sender: *4 required: - action @@ -170804,10 +170839,10 @@ x-webhooks: type: string enum: - locked - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 pull_request: title: Pull Request type: object @@ -173087,7 +173122,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 sender: *4 required: - action @@ -173167,12 +173202,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *709 - milestone: *553 - number: *759 - organization: *711 - pull_request: *761 - repository: *712 + enterprise: *720 + milestone: *557 + number: *770 + organization: *722 + pull_request: *772 + repository: *723 sender: *4 required: - action @@ -173251,12 +173286,12 @@ x-webhooks: type: string enum: - opened - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 + pull_request: *771 + repository: *723 sender: *4 required: - action @@ -173337,12 +173372,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 + pull_request: *771 + repository: *723 sender: *4 required: - action @@ -173422,12 +173457,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 + pull_request: *771 + repository: *723 sender: *4 required: - action @@ -173793,9 +173828,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 pull_request: type: object properties: @@ -175965,7 +176000,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *712 + repository: *723 sender: *4 required: - action @@ -176045,7 +176080,7 @@ x-webhooks: type: string enum: - deleted - comment: &763 + comment: &774 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -176330,9 +176365,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 pull_request: type: object properties: @@ -178490,7 +178525,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *712 + repository: *723 sender: *4 required: - action @@ -178570,11 +178605,11 @@ x-webhooks: type: string enum: - edited - changes: *762 - comment: *763 - enterprise: *709 - installation: *710 - organization: *711 + changes: *773 + comment: *774 + enterprise: *720 + installation: *721 + organization: *722 pull_request: type: object properties: @@ -180735,7 +180770,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *712 + repository: *723 sender: *4 required: - action @@ -180816,9 +180851,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -182991,7 +183026,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 + repository: *723 review: description: The review that was affected. type: object @@ -183238,9 +183273,9 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -185294,8 +185329,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 - review: &764 + repository: *723 + review: &775 description: The review that was affected. type: object properties: @@ -185528,12 +185563,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *711 + organization: *722 pull_request: title: Pull Request type: object @@ -187816,7 +187851,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 requested_reviewer: title: User type: object @@ -187900,12 +187935,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *711 + organization: *722 pull_request: title: Pull Request type: object @@ -190195,7 +190230,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 requested_team: title: Team description: Groups of organization members that gives permissions @@ -190387,12 +190422,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *711 + organization: *722 pull_request: title: Pull Request type: object @@ -192677,7 +192712,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 requested_reviewer: title: User type: object @@ -192762,12 +192797,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *711 + organization: *722 pull_request: title: Pull Request type: object @@ -195043,7 +195078,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 requested_team: title: Team description: Groups of organization members that gives permissions @@ -195224,9 +195259,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -197401,8 +197436,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 - review: *764 + repository: *723 + review: *775 sender: *4 required: - action @@ -197482,9 +197517,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -199554,7 +199589,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 + repository: *723 sender: *4 thread: type: object @@ -199941,9 +199976,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -201999,7 +202034,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 + repository: *723 sender: *4 thread: type: object @@ -202389,10 +202424,10 @@ x-webhooks: type: string before: type: string - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 pull_request: title: Pull Request type: object @@ -204663,7 +204698,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 sender: *4 required: - action @@ -204745,11 +204780,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *765 - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + assignee: *776 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 pull_request: title: Pull Request type: object @@ -207032,7 +207067,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 sender: *4 required: - action @@ -207111,11 +207146,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *709 - installation: *710 - label: *728 - number: *759 - organization: *711 + enterprise: *720 + installation: *721 + label: *739 + number: *770 + organization: *722 pull_request: title: Pull Request type: object @@ -209388,7 +209423,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 sender: *4 required: - action @@ -209469,10 +209504,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 pull_request: title: Pull Request type: object @@ -211737,7 +211772,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 sender: *4 required: - action @@ -211937,7 +211972,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *709 + enterprise: *720 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -212029,8 +212064,8 @@ x-webhooks: - url - author - committer - installation: *710 - organization: *711 + installation: *721 + organization: *722 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -212605,9 +212640,9 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 registry_package: type: object properties: @@ -213053,7 +213088,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *746 + items: *757 summary: type: string tag_name: @@ -213107,7 +213142,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *723 sender: *4 required: - action @@ -213185,9 +213220,9 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 registry_package: type: object properties: @@ -213495,7 +213530,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *746 + items: *757 summary: type: string tag_name: @@ -213544,7 +213579,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *723 sender: *4 required: - action @@ -213621,10 +213656,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - release: &766 + enterprise: *720 + installation: *721 + organization: *722 + release: &777 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -213942,7 +213977,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *712 + repository: *723 sender: *4 required: - action @@ -214019,11 +214054,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - release: *766 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + release: *777 + repository: *723 sender: *4 required: - action @@ -214140,11 +214175,11 @@ x-webhooks: type: boolean required: - to - enterprise: *709 - installation: *710 - organization: *711 - release: *766 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + release: *777 + repository: *723 sender: *4 required: - action @@ -214222,9 +214257,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -214546,7 +214581,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *712 + repository: *723 sender: *4 required: - action @@ -214622,10 +214657,10 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 - release: &767 + enterprise: *720 + installation: *721 + organization: *722 + release: &778 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -214944,7 +214979,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *712 + repository: *723 sender: *4 required: - action @@ -215020,11 +215055,11 @@ x-webhooks: type: string enum: - released - enterprise: *709 - installation: *710 - organization: *711 - release: *766 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + release: *777 + repository: *723 sender: *4 required: - action @@ -215100,11 +215135,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *709 - installation: *710 - organization: *711 - release: *767 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + release: *778 + repository: *723 sender: *4 required: - action @@ -215180,11 +215215,11 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - repository_advisory: *635 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + repository_advisory: *639 sender: *4 required: - action @@ -215260,11 +215295,11 @@ x-webhooks: type: string enum: - reported - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - repository_advisory: *635 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + repository_advisory: *639 sender: *4 required: - action @@ -215340,10 +215375,10 @@ x-webhooks: type: string enum: - archived - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -215420,10 +215455,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -215501,10 +215536,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -215588,10 +215623,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -215703,10 +215738,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -215778,10 +215813,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 status: type: string @@ -215862,10 +215897,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -215942,10 +215977,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -216039,10 +216074,10 @@ x-webhooks: - name required: - repository - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -216122,11 +216157,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - repository_ruleset: *298 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + repository_ruleset: *305 sender: *4 required: - action @@ -216204,11 +216239,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - repository_ruleset: *298 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + repository_ruleset: *305 sender: *4 required: - action @@ -216286,11 +216321,11 @@ x-webhooks: type: string enum: - edited - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - repository_ruleset: *298 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + repository_ruleset: *305 changes: type: object properties: @@ -216309,16 +216344,16 @@ x-webhooks: properties: added: type: array - items: *273 + items: *279 deleted: type: array - items: *273 + items: *279 updated: type: array items: type: object properties: - condition: *273 + condition: *279 changes: type: object properties: @@ -216351,16 +216386,16 @@ x-webhooks: properties: added: type: array - items: *592 + items: *595 deleted: type: array - items: *592 + items: *595 updated: type: array items: type: object properties: - rule: *592 + rule: *595 changes: type: object properties: @@ -216594,10 +216629,10 @@ x-webhooks: - from required: - owner - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -216675,10 +216710,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -216756,7 +216791,7 @@ x-webhooks: type: string enum: - create - alert: &768 + alert: &779 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -216877,10 +216912,10 @@ x-webhooks: type: string enum: - open - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -217086,10 +217121,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -217167,11 +217202,11 @@ x-webhooks: type: string enum: - reopen - alert: *768 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *779 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -217370,10 +217405,10 @@ x-webhooks: enum: - fixed - open - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -217391,7 +217426,7 @@ x-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. @@ -217399,8 +217434,8 @@ x-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: @@ -217444,18 +217479,18 @@ x-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: &769 + - assigned + alert: &780 type: object properties: - number: *161 - created_at: *162 + number: *167 + created_at: *168 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -217463,8 +217498,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *164 - html_url: *165 + url: *170 + html_url: *171 locations_url: type: string format: uri @@ -217569,10 +217604,93 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + assignee: *4 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + 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: *780 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -217653,11 +217771,11 @@ x-webhooks: type: string enum: - created - alert: *769 - installation: *710 - location: *770 - organization: *711 - repository: *712 + alert: *780 + installation: *721 + location: *781 + organization: *722 + repository: *723 sender: *4 required: - location @@ -217895,11 +218013,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *780 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -217977,11 +218095,11 @@ x-webhooks: type: string enum: - reopened - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *780 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -218059,11 +218177,94 @@ x-webhooks: type: string enum: - resolved - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *780 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + 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: *780 + assignee: *4 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -218141,11 +218342,11 @@ x-webhooks: type: string enum: - validated - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *780 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -218271,10 +218472,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *712 - enterprise: *709 - installation: *710 - organization: *711 + repository: *723 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -218352,11 +218553,11 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - security_advisory: &771 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + security_advisory: &782 description: The details of the security advisory, including summary, description, and severity. type: object @@ -218372,7 +218573,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *50 + cvss_severities: *54 cwes: type: array items: @@ -218539,11 +218740,11 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - security_advisory: *771 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + security_advisory: *782 sender: *4 required: - action @@ -218616,10 +218817,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -218636,7 +218837,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *50 + cvss_severities: *54 cwes: type: array items: @@ -218803,11 +219004,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *272 - enterprise: *709 - installation: *710 - organization: *711 - repository: *333 + security_and_analysis: *278 + enterprise: *720 + installation: *721 + organization: *722 + repository: *335 sender: *4 required: - changes @@ -218885,12 +219086,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: &772 + sponsorship: &783 type: object properties: created_at: @@ -219191,12 +219392,12 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *772 + sponsorship: *783 required: - action - sponsorship @@ -219284,12 +219485,12 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *772 + sponsorship: *783 required: - action - changes @@ -219366,17 +219567,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &773 + effective_date: &784 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: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *772 + sponsorship: *783 required: - action - sponsorship @@ -219450,7 +219651,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &774 + changes: &785 type: object properties: tier: @@ -219494,13 +219695,13 @@ x-webhooks: - from required: - tier - effective_date: *773 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + effective_date: *784 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *772 + sponsorship: *783 required: - action - changes @@ -219577,13 +219778,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *774 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + changes: *785 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *772 + sponsorship: *783 required: - action - changes @@ -219657,10 +219858,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -219743,10 +219944,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -220166,15 +220367,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *709 + enterprise: *720 id: description: The unique identifier of the status. type: integer - installation: *710 + installation: *721 name: type: string - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 sha: description: The Commit SHA. @@ -220283,15 +220484,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *82 - parent_issue_repo: *66 + parent_issue: *86 + parent_issue_repo: *70 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *82 - installation: *710 - organization: *711 - repository: *712 + sub_issue: *86 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -220375,15 +220576,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *82 - parent_issue_repo: *66 + parent_issue: *86 + parent_issue_repo: *70 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *82 - installation: *710 - organization: *711 - repository: *712 + sub_issue: *86 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -220467,15 +220668,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *82 - sub_issue_repo: *66 + sub_issue: *86 + sub_issue_repo: *70 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *82 - installation: *710 - organization: *711 - repository: *712 + parent_issue: *86 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -220559,15 +220760,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *82 - sub_issue_repo: *66 + sub_issue: *86 + sub_issue_repo: *70 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *82 - installation: *710 - organization: *711 - repository: *712 + parent_issue: *86 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -220644,12 +220845,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - team: &775 + team: &786 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -220872,9 +221073,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -221332,7 +221533,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *786 required: - action - team @@ -221408,9 +221609,9 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -221868,7 +222069,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *786 required: - action - team @@ -221945,9 +222146,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -222405,7 +222606,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *786 required: - action - team @@ -222549,9 +222750,9 @@ x-webhooks: - from required: - permissions - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -223009,7 +223210,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *786 required: - action - changes @@ -223087,9 +223288,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -223547,7 +223748,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *786 required: - action - team @@ -223623,10 +223824,10 @@ x-webhooks: type: string enum: - started - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -223699,16 +223900,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *709 + enterprise: *720 inputs: type: object nullable: true additionalProperties: true - installation: *710 - organization: *711 + installation: *721 + organization: *722 ref: type: string - repository: *712 + repository: *723 sender: *4 workflow: type: string @@ -223790,10 +223991,10 @@ x-webhooks: type: string enum: - completed - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: allOf: @@ -224030,7 +224231,7 @@ x-webhooks: type: string required: - conclusion - deployment: *484 + deployment: *488 required: - action - repository @@ -224109,10 +224310,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: allOf: @@ -224372,7 +224573,7 @@ x-webhooks: required: - status - steps - deployment: *484 + deployment: *488 required: - action - repository @@ -224451,10 +224652,10 @@ x-webhooks: type: string enum: - queued - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: type: object @@ -224589,7 +224790,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *484 + deployment: *488 required: - action - repository @@ -224668,10 +224869,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: type: object @@ -224807,7 +225008,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *484 + deployment: *488 required: - action - repository @@ -224887,12 +225088,12 @@ x-webhooks: type: string enum: - completed - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *724 + workflow: *735 workflow_run: title: Workflow Run type: object @@ -225891,12 +226092,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *724 + workflow: *735 workflow_run: title: Workflow Run type: object @@ -226880,12 +227081,12 @@ x-webhooks: type: string enum: - requested - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *724 + workflow: *735 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 5a35ecf80..3db5caa7f 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/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." @@ -4718,6 +4714,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.", @@ -5703,6 +5707,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.", @@ -6542,6 +6554,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.", @@ -7012,6 +7032,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.", @@ -9037,6 +9065,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.", @@ -10073,6 +10109,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.", @@ -11026,6 +11070,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.", @@ -11690,6 +11742,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.", @@ -16605,17 +16665,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": [ { @@ -16626,34 +16686,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": { @@ -16662,334 +16694,928 @@ "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", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "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", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "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", + "example": 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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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", + "example": 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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "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", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "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" + } + ] } } } @@ -52307,6 +52933,572 @@ } } }, + "/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", + "example": 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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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", + "example": 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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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", @@ -53594,6 +54786,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": { @@ -53683,6 +54916,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": [ @@ -54329,7 +55566,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" + ] + } + } } } } @@ -102968,6 +104220,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.", @@ -103968,6 +105228,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.", @@ -138995,19 +140263,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": [ { @@ -139019,15 +140285,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.", @@ -139038,9 +140295,749 @@ } } ], + "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.", + "example": "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", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was last updated." + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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": { @@ -139240,21 +141237,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", @@ -161444,6 +163459,35 @@ ] } } + }, + { + "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." + } + } + } + } } ] } @@ -166103,6 +168147,35 @@ ] } } + }, + { + "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." + } + } + } + } } ] } @@ -168149,6 +170222,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.", @@ -184462,17 +186558,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": [ { @@ -184520,42 +186616,28 @@ "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", + "example": 1296269 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "type": "string" - }, - "body": { "type": "string", - "nullable": true - }, - "number": { - "type": "integer" + "example": "Hello-World" }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -184679,55 +186761,538 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "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", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "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", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, "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", + "example": "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", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# 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", + "format": "uri", + "nullable": true } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "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" ] } }, @@ -184735,17 +187300,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=", @@ -184765,1385 +187324,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", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "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", - "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" - ] - } - }, - "nullable": true - }, - "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", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "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", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# 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", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "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" + } } } ] @@ -187605,164 +188876,465 @@ "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", - "example": "https://api.github.com/projects/columns/367" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - }, - "cards_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" - }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "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", - "example": "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" } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { + }, + "X-RateLimit-Remaining": { + "example": 4999, "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-Reset": { + "example": 1590701888, + "schema": { + "type": "integer", + "format": "timestamp" } } } }, - "401": { - "description": "Requires authentication", + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -187791,2870 +189363,741 @@ "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", - "example": "Remaining tasks", - "type": "string" - } - }, - "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", + "example": 1296269 + }, + "node_id": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "project_url": { + "name": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" + "example": "Hello-World" }, - "cards_url": { + "full_name": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" + "example": "octocat/Hello-World" }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "node_id": { + "private": { + "type": "boolean" + }, + "html_url": { "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true }, - "created_at": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "updated_at": { + "archive_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "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" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "url": { - "type": "string" + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "documentation_url": { - "type": "string" + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "url": { - "type": "string" + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "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" + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, - "documentation_url": { - "type": "string" + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, - "url": { - "type": "string" + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, - "documentation_url": { - "type": "string" + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "url": { - "type": "string" + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "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.", - "example": "last", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$" - } - }, - "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" + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, - "documentation_url": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "url": { - "type": "string" + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "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" + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "documentation_url": { - "type": "string" + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "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" + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - "documentation_url": { - "type": "string" + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, - "url": { - "type": "string" + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - "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" + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - "documentation_url": { - "type": "string" + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, - "url": { - "type": "string" + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, - "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" + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, - "documentation_url": { - "type": "string" + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, - "documentation_url": { - "type": "string" + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, - "url": { - "type": "string" + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, - "documentation_url": { - "type": "string" + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" }, - "url": { - "type": "string" + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, - "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", - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "example": "write", - "type": "string" - } - }, - "nullable": true - }, - "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" + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, - "documentation_url": { - "type": "string" + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, - "url": { - "type": "string" + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, - "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" + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, - "documentation_url": { - "type": "string" + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, - "documentation_url": { - "type": "string" + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" }, - "url": { - "type": "string" + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, - "documentation_url": { - "type": "string" + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" }, - "url": { - "type": "string" + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true }, - "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" + "language": { + "type": "string", + "nullable": true }, - "documentation_url": { - "type": "string" + "forks_count": { + "type": "integer", + "example": 9 }, - "url": { - "type": "string" + "stargazers_count": { + "type": "integer", + "example": 80 }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "watchers_count": { + "type": "integer", + "example": 80 }, - "documentation_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", + "example": 108 }, - "url": { - "type": "string" + "default_branch": { + "type": "string", + "example": "master" }, - "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" + "open_issues_count": { + "type": "integer", + "example": 0 }, - "documentation_url": { - "type": "string" + "is_template": { + "type": "boolean", + "example": true }, - "errors": { + "topics": { "type": "array", "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "type": "string" + }, + "example": [ + "octocat", + "atom", + "electron", + "API" + ] }, - "documentation_url": { - "type": "string" + "has_issues": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "has_projects": { + "type": "boolean", + "example": true }, - "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" + "has_wiki": { + "type": "boolean", + "example": true }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean", + "example": true + }, + "has_discussions": { + "type": "boolean", + "example": 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", + "example": "public" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z" + }, + "permissions": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "admin": { + "type": "boolean" }, - "email": { - "nullable": true, - "type": "string" + "maintain": { + "type": "boolean" }, - "login": { - "type": "string", - "example": "octocat" + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" }, + "pull": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "allow_rebase_merge": { + "type": "boolean", + "example": true + }, + "template_repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "format": "int64", - "example": 1 + "format": "int64" }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "type": { + "name": { + "description": "The name of the repository.", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "example": "Team Environment" }, - "starred_at": { + "full_name": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "example": "octocat/Hello-World" }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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", + "license": { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" + "key": { + "type": "string", + "example": "mit" }, - "reset": { - "type": "integer" + "name": { + "type": "string", + "example": "MIT License" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "graphql": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" }, - "remaining": { - "type": "integer" + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" }, - "reset": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" }, - "used": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "limit", - "remaining", - "reset", - "used" - ] + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true }, - "search": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] + "forks": { + "type": "integer" }, - "code_search": { - "title": "Rate Limit", + "permissions": { "type": "object", "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" + "admin": { + "type": "boolean" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "source_import": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "pull": { + "type": "boolean" }, - "remaining": { - "type": "integer" + "triage": { + "type": "boolean" }, - "reset": { - "type": "integer" + "push": { + "type": "boolean" }, - "used": { - "type": "integer" + "maintain": { + "type": "boolean" } }, "required": [ - "limit", - "remaining", - "reset", - "used" + "admin", + "pull", + "push" ] }, - "integration_manifest": { - "title": "Rate Limit", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "limit": { - "type": "integer" + "name": { + "nullable": true, + "type": "string" }, - "remaining": { - "type": "integer" + "email": { + "nullable": true, + "type": "string" }, - "reset": { - "type": "integer" + "login": { + "type": "string", + "example": "octocat" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_upload": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "remaining": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "reset": { - "type": "integer" + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "actions_runner_registration": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "remaining": { - "type": "integer" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "reset": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "scim": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "remaining": { - "type": "integer" + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "reset": { - "type": "integer" + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_snapshots": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "remaining": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "reset": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_sbom": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, - "remaining": { - "type": "integer" + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "reset": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_autofix": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "type": { + "type": "string", + "example": "User" }, - "remaining": { - "type": "integer" + "site_admin": { + "type": "boolean" }, - "reset": { - "type": "integer" + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" }, - "used": { - "type": "integer" + "user_view_type": { + "type": "string", + "example": "public" } }, "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", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 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", - "example": 108 - }, - "default_branch": { - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "example": true - }, - "has_projects": { - "type": "boolean", - "example": true - }, - "has_wiki": { - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "example": true - }, - "has_discussions": { - "type": "boolean", - "example": 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", - "example": "public" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "example": true - }, - "template_repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "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": { @@ -198509,6 +197952,608 @@ } } }, + "/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", + "example": 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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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", + "example": 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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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", @@ -224334,6 +224379,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -224354,6 +224400,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -242552,6 +242599,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -242572,6 +242620,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -278220,6 +278269,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -278240,6 +278290,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -283974,6 +284025,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -283994,6 +284046,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289303,6 +289356,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289323,6 +289377,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289849,6 +289904,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -289869,6 +289925,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -290419,6 +290476,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -290439,6 +290497,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -324211,6 +324270,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.", @@ -406452,6 +406519,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -406472,6 +406540,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -437285,6 +437354,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -437305,6 +437375,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -468363,6 +468434,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.", @@ -470603,7 +470697,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" @@ -470673,6 +470767,11 @@ "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", "type": "string", "nullable": true + }, + "assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true } }, "anyOf": [ @@ -470680,6 +470779,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -470689,6 +470793,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -471665,7 +471781,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 + } } } } @@ -471679,7 +471815,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", @@ -498900,6 +499036,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -499112,6 +499249,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -512070,17 +512208,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": [ { @@ -512119,42 +512257,28 @@ "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", + "example": 1296269 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "type": "string" - }, - "body": { "type": "string", - "nullable": true - }, - "number": { - "type": "integer" + "example": "Hello-World" }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -512278,55 +512402,538 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "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", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "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", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, "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", + "example": "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", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# 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", + "format": "uri", + "nullable": true + } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "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" ] } }, @@ -512334,17 +512941,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=", @@ -512364,1564 +512965,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", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "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", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# 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", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "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" + } } } ] @@ -540360,6 +539494,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.", @@ -589101,6 +588243,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.", @@ -595498,51 +594648,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": { @@ -595733,7 +595112,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", @@ -595743,37 +595155,509 @@ "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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.", + "example": "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", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was last updated." + } + }, + "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": { @@ -647113,6 +646997,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -649494,6 +649385,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -757124,6 +757022,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.", @@ -759716,6 +759622,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.", @@ -762215,6 +762129,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.", @@ -764714,6 +764636,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.", @@ -767345,6 +767275,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.", @@ -769983,6 +769921,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.", @@ -774244,6 +774190,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.", @@ -1168125,949 +1168079,4357 @@ ] } }, - "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." + }, + "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" + } + } + } + } + } + } + } + } + } + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "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", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": 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", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "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", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "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", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": 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", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "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", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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", @@ -1169196,7 +1172558,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1169211,8 +1172573,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1169220,13 +1172583,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": [ { @@ -1169291,200 +1172654,180 @@ "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": { + "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", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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", + "nullable": true + }, + "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", + "nullable": true, + "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", @@ -1170992,7 +1174335,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1171008,23 +1174351,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": [ { @@ -1171089,15 +1174430,191 @@ "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", + "nullable": true + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "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).\"", @@ -1172604,6 +1176121,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1172619,21 +1176137,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" }, @@ -1172700,13 +1176216,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": { @@ -1174405,11 +1177921,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" }, @@ -1174476,13 +1177992,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": { @@ -1174493,9 +1178009,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1174515,10 +1178028,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": "string", - "nullable": true - }, "dismiss_reason": { "type": "string" }, @@ -1174614,9 +1178123,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1174656,7 +1178162,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1176163,279 +1179670,855 @@ "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", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "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": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { + "type": "string", + "description": "The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true + }, + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1177944,8 +1182027,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1177959,21 +1182041,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": [ { @@ -1178038,179 +1182121,630 @@ "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": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", - "type": "object", + "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", + "description": "The reason for resolving the alert.", "nullable": true, - "required": [ - "login", - "id" - ], + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "format": "uri" + "example": "octocat" }, - "deleted": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "email": { + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "gravatar_id": { - "type": "string" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "html_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "login": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { "name": { + "nullable": true, "type": "string" }, - "node_id": { + "email": { + "nullable": true, "type": "string" }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "example": "User" }, "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, "starred_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "example": "User" }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - }, - "external_identifier": { - "type": "string" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "external_reference": { + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "nullable": true, - "format": "uri" - }, - "fix_reason": { - "type": "string" + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "fixed_at": { + "push_protection_bypass_request_comment": { "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true }, - "node_id": { - "type": "string" + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true }, - "number": { - "type": "integer" + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true }, - "severity": { - "type": "string" + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" - ] + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true } } }, @@ -1179721,8 +1184255,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1179736,21 +1184269,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": [ { @@ -1179815,7 +1184349,7 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { @@ -1180442,74 +1184976,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", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1180531,6 +1184997,314 @@ "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.", + "example": "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", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ] + } + } + }, "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.", @@ -1181947,10 +1186721,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" + } + } } } } @@ -1181962,8 +1186911,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1181972,13 +1186922,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": [ { @@ -1182043,13 +1186993,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": { @@ -1182670,6 +1187620,74 @@ } } }, + "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", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1182691,314 +1187709,6 @@ "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.", - "example": "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", - "example": "/example/secrets.txt" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "example": "/example/Home.md" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082" - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussion-4566270" - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } - ] - } - } - }, "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.", @@ -1184415,185 +1189125,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" - } - } } } } @@ -1184605,9 +1189140,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1184616,11 +1189150,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" }, @@ -1184687,13 +1189221,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": { @@ -1186844,11 +1191378,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" }, @@ -1186915,13 +1191449,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": { @@ -1189072,11 +1193606,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" }, @@ -1189143,13 +1193677,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": { @@ -1189770,6 +1194304,130 @@ } } }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "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/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index e26d2a991..58e913ad7 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/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 - - &40 + - &45 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 - - &41 + - &46 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 - - &48 + - &52 name: direction description: The direction to sort the results by. in: query @@ -679,7 +677,7 @@ paths: required: - vector_string - score - cvss_severities: &50 + cvss_severities: &54 type: object nullable: true properties: @@ -719,7 +717,7 @@ paths: required: - vector_string - score - epss: &51 + epss: &55 type: object nullable: true readOnly: true @@ -857,7 +855,7 @@ paths: - subscriptions_url - type - url - type: &304 + type: &311 type: string description: The type of credit the user is receiving. enum: @@ -990,7 +988,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &113 + schema: &119 title: Validation Error Simple description: Validation Error Simple type: object @@ -1023,7 +1021,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &637 + - &641 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1141,7 +1139,7 @@ paths: GitHub. type: object nullable: true - properties: &67 + properties: &71 id: description: Unique identifier of the GitHub app example: 37 @@ -1274,7 +1272,7 @@ paths: about itself. example: 5 type: integer - required: &68 + required: &72 - id - node_id - owner @@ -1579,7 +1577,7 @@ paths: schema: type: integer default: 30 - - &197 + - &203 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 @@ -1595,7 +1593,7 @@ paths: application/json: schema: type: array - items: &198 + items: &204 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1675,7 +1673,7 @@ paths: - installation_id - repository_id examples: - default: &199 + default: &205 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1734,7 +1732,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &112 + schema: &118 title: Validation Error description: Validation Error type: object @@ -1803,7 +1801,7 @@ paths: description: Response content: application/json: - schema: &200 + schema: &206 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1917,7 +1915,7 @@ paths: - request - response examples: - default: &201 + default: &207 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2118,7 +2116,7 @@ paths: parameters: - *17 - *19 - - &72 + - &76 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) @@ -2208,6 +2206,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 @@ -2693,7 +2698,7 @@ paths: suspended_at: suspended_by: headers: - Link: &54 + Link: &58 example: ; rel="next", ; rel="last" schema: @@ -2882,11 +2887,11 @@ paths: - selected repositories: type: array - items: &66 + items: &70 title: Repository description: A repository on GitHub. type: object - properties: &270 + properties: &276 id: description: Unique identifier of the repository example: 42 @@ -2906,7 +2911,7 @@ paths: title: License Simple description: License Simple type: object - properties: &83 + properties: &87 key: type: string example: mit @@ -2928,7 +2933,7 @@ paths: html_url: type: string format: uri - required: &84 + required: &88 - key - name - url @@ -3324,7 +3329,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &271 + required: &277 - archive_url - assignees_url - blobs_url @@ -5111,7 +5116,7 @@ paths: responses: '202': *39 '422': *7 - '500': &103 + '500': &109 description: Internal Error content: application/json: @@ -7026,6 +7031,164 @@ 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: + - &40 + 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: &41 + 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 + example: 14 + examples: + default: &42 + value: + max_cache_retention_days: 80 + '403': *29 + '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: + - *40 + requestBody: + required: true + content: + application/json: + schema: *41 + examples: + selected_actions: *42 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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: + - *40 + responses: + '200': + description: Response + content: + application/json: + schema: &43 + 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 + example: 10 + examples: + default: &44 + value: + max_cache_size_gb: 150 + '403': *29 + '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: + - *40 + requestBody: + required: true + content: + application/json: + schema: *43 + examples: + selected_actions: *44 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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 @@ -7042,13 +7205,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise parameters: - - &42 - name: enterprise - description: The slug version of the enterprise name. - in: path - required: true - schema: - type: string + - *40 - name: per_page in: query description: The number of results per page (max 100). For more information, @@ -7057,8 +7214,8 @@ paths: schema: type: integer default: 30 - - *40 - - *41 + - *45 + - *46 responses: '200': description: Response @@ -7066,7 +7223,7 @@ paths: application/json: schema: type: array - items: &43 + items: &47 type: object description: A code security configuration properties: @@ -7357,7 +7514,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise parameters: - - *42 + - *40 requestBody: required: true content: @@ -7435,7 +7592,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &171 + code_scanning_options: &177 type: object description: Security Configuration feature options for code scanning nullable: true @@ -7452,7 +7609,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &46 + code_scanning_default_setup_options: &50 type: object description: Feature options for code scanning default setup nullable: true @@ -7569,9 +7726,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *43 + schema: *47 examples: - default: &44 + default: &48 value: id: 1325 target_type: enterprise @@ -7623,13 +7780,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise parameters: - - *42 + - *40 responses: '200': description: Response content: application/json: - schema: &173 + schema: &179 type: array description: A list of default code security configurations items: @@ -7643,9 +7800,9 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *43 + configuration: *47 examples: - default: &174 + default: &180 value: - default_for_new_repos: public configuration: @@ -7733,8 +7890,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise parameters: - - *42 - - &45 + - *40 + - &49 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -7746,9 +7903,9 @@ paths: description: Response content: application/json: - schema: *43 + schema: *47 examples: - default: *44 + default: *48 '304': *37 '403': *29 '404': *6 @@ -7772,8 +7929,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: - - *42 - - *45 + - *40 + - *49 requestBody: required: true content: @@ -7852,7 +8009,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *46 + code_scanning_default_setup_options: *50 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -7940,13 +8097,13 @@ paths: description: Response content: application/json: - schema: *43 + schema: *47 examples: - default: *44 + default: *48 '304': *37 '403': *29 '404': *6 - '409': &47 + '409': &51 description: Conflict content: application/json: @@ -7973,15 +8130,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise parameters: - - *42 - - *45 + - *40 + - *49 responses: - '204': &175 + '204': &181 description: A header with no content is returned. '400': *14 '403': *29 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8005,8 +8162,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories parameters: - - *42 - - *45 + - *40 + - *49 requestBody: required: true content: @@ -8033,7 +8190,7 @@ paths: '202': *39 '403': *29 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -8057,8 +8214,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: - - *42 - - *45 + - *40 + - *49 requestBody: required: true content: @@ -8098,12 +8255,12 @@ paths: - none - private_and_internal - public - configuration: *43 + configuration: *47 examples: default: value: default_for_new_repos: all - configuration: &172 + configuration: &178 value: id: 1325 target_type: organization @@ -8159,8 +8316,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: - - *42 - - *45 + - *40 + - *49 - 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)." @@ -8169,8 +8326,8 @@ paths: schema: type: integer default: 30 - - *40 - - *41 + - *45 + - *46 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -8188,7 +8345,7 @@ paths: application/json: schema: type: array - items: &176 + items: &182 type: object description: Repositories associated with a code security configuration and attachment status @@ -8206,11 +8363,11 @@ paths: - failed - updating - removed_by_enterprise - repository: &53 + repository: &57 title: Simple Repository description: A GitHub repository. type: object - properties: &100 + properties: &106 id: type: integer format: int64 @@ -8437,7 +8594,7 @@ paths: format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. - required: &101 + required: &107 - archive_url - assignees_url - blobs_url @@ -8489,7 +8646,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &177 + repository: &183 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -8582,8 +8739,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - - *42 - - &182 + - *40 + - &188 name: state in: query description: |- @@ -8592,7 +8749,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &183 + - &189 name: severity in: query description: |- @@ -8601,7 +8758,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &184 + - &190 name: ecosystem in: query description: |- @@ -8610,14 +8767,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &185 + - &191 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 - - &186 + - &192 name: epss_percentage in: query description: |- @@ -8629,7 +8786,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 - - &475 + - &479 name: has in: query description: |- @@ -8643,7 +8800,7 @@ paths: type: string enum: - patch - - &187 + - &193 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -8653,7 +8810,7 @@ paths: enum: - development - runtime - - &188 + - &194 name: sort in: query description: |- @@ -8668,9 +8825,9 @@ paths: - updated - epss_percentage default: created - - *48 - - *40 - - *41 + - *52 + - *45 + - *46 - *17 responses: '200': @@ -8679,11 +8836,11 @@ paths: application/json: schema: type: array - items: &189 + items: &195 type: object description: A Dependabot alert. properties: - number: &161 + number: &167 type: integer description: The security alert number. readOnly: true @@ -8701,7 +8858,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: &49 + package: &53 type: object description: Details for the vulnerable package. readOnly: true @@ -8745,7 +8902,7 @@ paths: - unknown - direct - transitive - security_advisory: &476 + security_advisory: &480 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -8775,13 +8932,13 @@ paths: description: Vulnerable version range information for the advisory. readOnly: true - items: &52 + items: &56 type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: - package: *49 + package: *53 severity: type: string description: The severity of the vulnerability. @@ -8847,8 +9004,8 @@ paths: - score - vector_string additionalProperties: false - cvss_severities: *50 - epss: *51 + cvss_severities: *54 + epss: *55 cwes: type: array description: Details for the advisory pertaining to Common @@ -8947,30 +9104,30 @@ paths: - updated_at - withdrawn_at additionalProperties: false - security_vulnerability: *52 - url: &164 + security_vulnerability: *56 + url: &170 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &165 + html_url: &171 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &162 + created_at: &168 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: &163 + updated_at: &169 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: &167 + dismissed_at: &173 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -9000,21 +9157,21 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: &166 + fixed_at: &172 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - auto_dismissed_at: &477 + auto_dismissed_at: &481 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - repository: *53 + repository: *57 required: - number - state @@ -9033,7 +9190,7 @@ paths: - repository additionalProperties: false examples: - default: &190 + default: &196 value: - number: 2 state: dismissed @@ -9372,7 +9529,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams parameters: - - *42 + - *40 - *17 - *19 responses: @@ -9382,7 +9539,7 @@ paths: application/json: schema: type: array - items: &55 + items: &59 title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -9440,7 +9597,7 @@ paths: - updated_at - group_id examples: - default: &56 + default: &60 value: - id: 1 name: Justice League @@ -9453,7 +9610,7 @@ paths: created_at: '2019-01-26T19:01:12Z' updated_at: '2019-01-26T19:14:43Z' headers: - Link: *54 + Link: *58 '403': *29 x-github: githubCloudOnly: false @@ -9471,7 +9628,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#create-an-enterprise-team parameters: - - *42 + - *40 requestBody: required: true content: @@ -9526,9 +9683,9 @@ paths: description: Response content: application/json: - schema: *55 + schema: *59 examples: - default: *56 + default: *60 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9545,8 +9702,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - - *42 - - &57 + - *40 + - &61 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -9565,7 +9722,7 @@ paths: type: array items: *4 examples: - default: &58 + default: &62 value: - login: octocat id: 1 @@ -9586,7 +9743,7 @@ paths: type: User site_admin: false headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9603,8 +9760,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - - *42 - - *57 + - *40 + - *61 requestBody: required: true content: @@ -9635,7 +9792,7 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9652,8 +9809,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - - *42 - - *57 + - *40 + - *61 requestBody: required: true content: @@ -9684,7 +9841,7 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9701,9 +9858,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - - *42 - - *57 - - &59 + - *40 + - *61 + - &63 name: username description: The handle for the GitHub user account. in: path @@ -9717,7 +9874,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &60 + exampleKey1: &64 value: login: octocat id: 1 @@ -9752,9 +9909,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - - *42 - - *57 - - *59 + - *40 + - *61 + - *63 responses: '201': description: Successfully added team member @@ -9762,7 +9919,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *60 + exampleKey1: *64 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9779,9 +9936,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - - *42 - - *57 - - *59 + - *40 + - *61 + - *63 responses: '204': description: Response @@ -9802,8 +9959,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments parameters: - - *42 - - *57 + - *40 + - *61 - *17 - *19 responses: @@ -9813,11 +9970,11 @@ paths: application/json: schema: type: array - items: &61 + items: &65 title: Organization Simple description: A GitHub organization. type: object - properties: &179 + properties: &185 login: type: string example: github @@ -9858,7 +10015,7 @@ paths: type: string example: A great organization nullable: true - required: &180 + required: &186 - login - url - id @@ -9872,7 +10029,7 @@ paths: - avatar_url - description examples: - default: &62 + default: &66 value: login: github id: 1 @@ -9902,8 +10059,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments parameters: - - *42 - - *57 + - *40 + - *61 requestBody: required: true content: @@ -9931,9 +10088,9 @@ paths: application/json: schema: type: array - items: *61 + items: *65 examples: - default: &99 + default: &103 value: - login: github id: 1 @@ -9963,8 +10120,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments parameters: - - *42 - - *57 + - *40 + - *61 requestBody: required: true content: @@ -10004,9 +10161,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment parameters: - - *42 - - *57 - - &63 + - *40 + - *61 + - &67 name: org description: The organization name. The name is not case sensitive. in: path @@ -10018,9 +10175,9 @@ paths: description: The team is assigned to the organization content: application/json: - schema: *61 + schema: *65 examples: - default: *62 + default: *66 '404': description: The team is not assigned to the organization x-github: @@ -10038,17 +10195,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment parameters: - - *42 - - *57 - - *63 + - *40 + - *61 + - *67 responses: '201': description: Successfully assigned the enterprise team to the organization. content: application/json: - schema: *61 + schema: *65 examples: - default: *62 + default: *66 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10064,9 +10221,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment parameters: - - *42 - - *57 - - *63 + - *40 + - *61 + - *67 responses: '204': description: Successfully unassigned the enterprise team from the organization. @@ -10089,8 +10246,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - - *42 - - &64 + - *40 + - &68 name: team_slug description: The slug of the team name. in: path @@ -10102,11 +10259,11 @@ paths: description: Response content: application/json: - schema: *55 + schema: *59 examples: - default: *56 + default: *60 headers: - Link: *54 + Link: *58 '403': *29 x-github: githubCloudOnly: false @@ -10123,8 +10280,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - - *42 - - *64 + - *40 + - *68 requestBody: required: true content: @@ -10179,11 +10336,11 @@ paths: description: Response content: application/json: - schema: *55 + schema: *59 examples: - default: *56 + default: *60 headers: - Link: *54 + Link: *58 '403': *29 x-github: githubCloudOnly: false @@ -10203,8 +10360,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - - *42 - - *64 + - *40 + - *68 responses: '204': description: Response @@ -10242,7 +10399,7 @@ paths: application/json: schema: type: array - items: &94 + items: &98 title: Event description: Event type: object @@ -10252,7 +10409,7 @@ paths: type: type: string nullable: true - actor: &65 + actor: &69 title: Actor description: Actor type: object @@ -10292,18 +10449,18 @@ paths: - id - name - url - org: *65 + org: *69 payload: type: object properties: action: type: string - issue: &82 + issue: &86 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &526 + properties: &530 id: type: integer format: int64 @@ -10415,7 +10572,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &256 + properties: &262 url: type: string format: uri @@ -10485,7 +10642,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &257 + required: &263 - closed_issues - creator - description @@ -10564,7 +10721,7 @@ paths: timeline_url: type: string format: uri - type: &219 + type: &225 title: Issue Type description: The type of issue. type: object @@ -10613,7 +10770,7 @@ paths: - node_id - name - description - repository: *66 + repository: *70 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -10623,9 +10780,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 - author_association: &69 + properties: *71 + required: *72 + author_association: &73 title: author_association type: string example: OWNER @@ -10639,7 +10796,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &70 + reactions: &74 title: Reaction Rollup type: object properties: @@ -10675,7 +10832,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &649 + sub_issues_summary: &653 title: Sub-issues Summary type: object properties: @@ -10695,7 +10852,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &650 + issue_dependencies_summary: &654 title: Issue Dependencies Summary type: object properties: @@ -10714,7 +10871,7 @@ paths: - total_blocking issue_field_values: type: array - items: &651 + items: &655 title: Issue Field Value description: A value assigned to an issue field type: object @@ -10774,7 +10931,7 @@ paths: - node_id - data_type - value - required: &527 + required: &531 - assignee - closed_at - comments @@ -10795,7 +10952,7 @@ paths: - user - created_at - updated_at - comment: &524 + comment: &528 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -10843,7 +11000,7 @@ paths: issue_url: type: string format: uri - author_association: *69 + author_association: *73 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -10853,9 +11010,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 - reactions: *70 + properties: *71 + required: *72 + reactions: *74 required: - id - node_id @@ -10941,7 +11098,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': &104 + '503': &110 description: Service unavailable content: application/json: @@ -11034,7 +11191,7 @@ paths: _links: type: object properties: - timeline: &71 + timeline: &75 title: Link With Type description: Hypermedia Link with Type type: object @@ -11046,17 +11203,17 @@ paths: required: - href - type - user: *71 - security_advisories: *71 - current_user: *71 - current_user_public: *71 - current_user_actor: *71 - current_user_organization: *71 + user: *75 + security_advisories: *75 + current_user: *75 + current_user_public: *75 + current_user_actor: *75 + current_user_organization: *75 current_user_organizations: type: array - items: *71 - repository_discussions: *71 - repository_discussions_category: *71 + items: *75 + repository_discussions: *75 + repository_discussions_category: *75 required: - timeline - user @@ -11118,7 +11275,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *72 + - *76 - *17 - *19 responses: @@ -11128,7 +11285,7 @@ paths: application/json: schema: type: array - items: &73 + items: &77 title: Base Gist description: Base Gist type: object @@ -11227,7 +11384,7 @@ paths: - created_at - updated_at examples: - default: &74 + default: &78 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -11272,7 +11429,7 @@ paths: site_admin: false truncated: false headers: - Link: *54 + Link: *58 '304': *37 '403': *29 x-github: @@ -11348,7 +11505,7 @@ paths: description: Response content: application/json: - schema: &75 + schema: &79 title: Gist Simple description: Gist Simple type: object @@ -11365,7 +11522,7 @@ paths: url: type: string format: uri - user: &663 + user: &665 title: Public User description: Public User type: object @@ -11727,7 +11884,7 @@ paths: truncated: type: boolean examples: - default: &76 + default: &80 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -11831,7 +11988,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *72 + - *76 - *17 - *19 responses: @@ -11841,11 +11998,11 @@ paths: application/json: schema: type: array - items: *73 + items: *77 examples: - default: *74 + default: *78 headers: - Link: *54 + Link: *58 '422': *15 '304': *37 '403': *29 @@ -11865,7 +12022,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *72 + - *76 - *17 - *19 responses: @@ -11875,11 +12032,11 @@ paths: application/json: schema: type: array - items: *73 + items: *77 examples: - default: *74 + default: *78 headers: - Link: *54 + Link: *58 '401': *25 '304': *37 '403': *29 @@ -11905,7 +12062,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &77 + - &81 name: gist_id description: The unique identifier of the gist. in: path @@ -11917,10 +12074,10 @@ paths: description: Response content: application/json: - schema: *75 + schema: *79 examples: - default: *76 - '403': &80 + default: *80 + '403': &84 description: Forbidden Gist content: application/json: @@ -11968,7 +12125,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *77 + - *81 requestBody: required: true content: @@ -12028,9 +12185,9 @@ paths: description: Response content: application/json: - schema: *75 + schema: *79 examples: - updateGist: *76 + updateGist: *80 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -12188,7 +12345,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *77 + - *81 responses: '204': description: Response @@ -12217,7 +12374,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *77 + - *81 - *17 - *19 responses: @@ -12227,7 +12384,7 @@ paths: application/json: schema: type: array - items: &78 + items: &82 title: Gist Comment description: A comment made to a gist. type: object @@ -12262,7 +12419,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *69 + author_association: *73 required: - url - id @@ -12302,7 +12459,7 @@ paths: updated_at: '2011-04-18T23:23:56Z' author_association: COLLABORATOR headers: - Link: *54 + Link: *58 '304': *37 '404': *6 '403': *29 @@ -12327,7 +12484,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *77 + - *81 requestBody: required: true content: @@ -12352,9 +12509,9 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: &79 + default: &83 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -12412,8 +12569,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *77 - - &81 + - *81 + - &85 name: comment_id description: The unique identifier of the comment. in: path @@ -12426,12 +12583,12 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *79 + default: *83 '304': *37 '404': *6 - '403': *80 + '403': *84 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -12453,8 +12610,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *77 - *81 + - *85 requestBody: required: true content: @@ -12479,9 +12636,9 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *79 + default: *83 '404': *6 x-github: githubCloudOnly: false @@ -12498,8 +12655,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *77 - *81 + - *85 responses: '204': description: Response @@ -12522,7 +12679,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *77 + - *81 - *17 - *19 responses: @@ -12623,7 +12780,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *77 + - *81 - *17 - *19 responses: @@ -12633,7 +12790,7 @@ paths: application/json: schema: type: array - items: *75 + items: *79 examples: default: value: @@ -12679,7 +12836,7 @@ paths: type: User site_admin: false headers: - Link: *54 + Link: *58 '404': *6 '304': *37 '403': *29 @@ -12698,13 +12855,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *77 + - *81 responses: '201': description: Response content: application/json: - schema: *73 + schema: *77 examples: default: value: @@ -12775,7 +12932,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *77 + - *81 responses: '204': description: Response if gist is starred @@ -12805,7 +12962,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *77 + - *81 responses: '204': description: Response @@ -12827,7 +12984,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *77 + - *81 responses: '204': description: Response @@ -12856,7 +13013,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *77 + - *81 - name: sha in: path required: true @@ -12867,9 +13024,9 @@ paths: description: Response content: application/json: - schema: *75 + schema: *79 examples: - default: *76 + default: *80 '422': *15 '404': *6 '403': *29 @@ -13028,7 +13185,7 @@ paths: type: integer repositories: type: array - items: *66 + items: *70 repository_selection: type: string example: selected @@ -13151,7 +13308,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *54 + Link: *58 '403': *29 '304': *37 '401': *25 @@ -13235,7 +13392,7 @@ paths: - closed - all default: open - - &222 + - &228 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -13253,8 +13410,8 @@ paths: - updated - comments default: created - - *48 - - *72 + - *52 + - *76 - name: collab in: query required: false @@ -13284,9 +13441,9 @@ paths: application/json: schema: type: array - items: *82 + items: *86 examples: - default: &223 + default: &229 value: - id: 1 node_id: MDU6SXNzdWUx @@ -13530,7 +13687,7 @@ paths: watchers: 1 author_association: COLLABORATOR headers: - Link: *54 + Link: *58 '422': *15 '304': *37 '404': *6 @@ -13569,8 +13726,8 @@ paths: title: License Simple description: License Simple type: object - properties: *83 - required: *84 + properties: *87 + required: *88 examples: default: value: @@ -13855,7 +14012,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &85 + X-CommonMarker-Version: &89 example: 0.17.4 schema: type: string @@ -13910,7 +14067,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *85 + X-CommonMarker-Version: *89 content: text/html: schema: @@ -13939,7 +14096,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &88 + - &92 name: account_id description: account_id parameter in: path @@ -13951,7 +14108,7 @@ paths: description: Response content: application/json: - schema: &87 + schema: &91 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -13981,7 +14138,7 @@ paths: nullable: true id: type: integer - plan: &86 + plan: &90 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -14070,7 +14227,7 @@ paths: nullable: true updated_at: type: string - plan: *86 + plan: *90 required: - url - id @@ -14078,7 +14235,7 @@ paths: - login - marketplace_purchase examples: - default: &89 + default: &93 value: url: https://api.github.com/orgs/github type: Organization @@ -14163,9 +14320,9 @@ paths: application/json: schema: type: array - items: *86 + items: *90 examples: - default: &90 + default: &94 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -14183,7 +14340,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *54 + Link: *58 '404': *6 '401': *25 x-github: @@ -14205,14 +14362,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &91 + - &95 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &92 + - &96 name: sort description: The property to sort the results by. in: query @@ -14242,9 +14399,9 @@ paths: application/json: schema: type: array - items: *87 + items: *91 examples: - default: &93 + default: &97 value: - url: https://api.github.com/orgs/github type: Organization @@ -14295,7 +14452,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *54 + Link: *58 '404': *6 '422': *15 '401': *25 @@ -14318,15 +14475,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *88 + - *92 responses: '200': description: Response content: application/json: - schema: *87 + schema: *91 examples: - default: *89 + default: *93 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -14358,11 +14515,11 @@ paths: application/json: schema: type: array - items: *86 + items: *90 examples: - default: *90 + default: *94 headers: - Link: *54 + Link: *58 '401': *25 x-github: githubCloudOnly: false @@ -14383,8 +14540,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *91 - - *92 + - *95 + - *96 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -14404,11 +14561,11 @@ paths: application/json: schema: type: array - items: *87 + items: *91 examples: - default: *93 + default: *97 headers: - Link: *54 + Link: *58 '401': *25 x-github: githubCloudOnly: false @@ -14670,14 +14827,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &327 + - &332 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &328 + - &333 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -14694,7 +14851,7 @@ paths: application/json: schema: type: array - items: *94 + items: *98 examples: default: value: @@ -14739,7 +14896,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &334 + '301': &336 description: Moved permanently content: application/json: @@ -14761,7 +14918,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &556 + - &560 name: all description: If `true`, show notifications marked as read. in: query @@ -14769,7 +14926,7 @@ paths: schema: type: boolean default: false - - &557 + - &561 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -14778,8 +14935,8 @@ paths: schema: type: boolean default: false - - *72 - - &558 + - *76 + - &562 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: @@ -14804,18 +14961,18 @@ paths: application/json: schema: type: array - items: &95 + items: &99 title: Thread description: Thread type: object properties: id: type: string - repository: &143 + repository: &149 title: Minimal Repository description: Minimal Repository type: object - properties: &192 + properties: &198 id: type: integer format: int64 @@ -15091,7 +15248,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &272 + security_and_analysis: &278 nullable: true type: object properties: @@ -15165,7 +15322,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &193 + required: &199 - archive_url - assignees_url - blobs_url @@ -15253,7 +15410,7 @@ paths: - url - subscription_url examples: - default: &559 + default: &563 value: - id: '1' repository: @@ -15335,7 +15492,7 @@ paths: url: https://api.github.com/notifications/threads/1 subscription_url: https://api.github.com/notifications/threads/1/subscription headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -15419,7 +15576,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &96 + - &100 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 @@ -15433,7 +15590,7 @@ paths: description: Response content: application/json: - schema: *95 + schema: *99 examples: default: value: @@ -15535,7 +15692,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *96 + - *100 responses: '205': description: Reset Content @@ -15557,7 +15714,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *96 + - *100 responses: '204': description: No content @@ -15580,13 +15737,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *96 + - *100 responses: '200': description: Response content: application/json: - schema: &97 + schema: &101 title: Thread Subscription description: Thread Subscription type: object @@ -15623,7 +15780,7 @@ paths: - url - subscribed examples: - default: &98 + default: &102 value: subscribed: true ignored: false @@ -15654,7 +15811,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *96 + - *100 requestBody: required: false content: @@ -15675,9 +15832,9 @@ paths: description: Response content: application/json: - schema: *97 + schema: *101 examples: - default: *98 + default: *102 '304': *37 '403': *29 '401': *25 @@ -15700,7 +15857,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *96 + - *100 responses: '204': description: Response @@ -15795,9 +15952,9 @@ paths: application/json: schema: type: array - items: *61 + items: *65 examples: - default: *99 + default: *103 headers: Link: example: ; rel="next" @@ -15809,6 +15966,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: + - *67 + responses: + '200': + description: Response + content: + application/json: + schema: &104 + 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 + example: 14 + examples: + default: *42 + '403': *29 + '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: + - *67 + requestBody: + required: true + content: + application/json: + schema: *104 + examples: + selected_actions: *42 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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: + - *67 + responses: + '200': + description: Response + content: + application/json: + schema: &105 + 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 + example: 10 + examples: + default: *44 + '403': *29 + '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: + - *67 + requestBody: + required: true + content: + application/json: + schema: *105 + examples: + selected_actions: *44 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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 @@ -15824,7 +16127,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: - - *63 + - *67 - name: page in: query description: The page number of results to fetch. @@ -15868,8 +16171,8 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: *100 - required: *101 + properties: *106 + required: *107 nullable: true additionalProperties: false examples: @@ -15975,7 +16278,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *63 + - *67 requestBody: required: true content: @@ -16041,7 +16344,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *63 + - *67 requestBody: required: true content: @@ -16093,7 +16396,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: - - *63 + - *67 responses: '200': description: Response @@ -16101,7 +16404,7 @@ paths: application/json: schema: type: array - items: &102 + items: &108 title: Custom Property Value description: Custom property name and associated value type: object @@ -16121,7 +16424,7 @@ paths: - property_name - value examples: - default: &565 + default: &569 value: - property_name: environment value: production @@ -16155,7 +16458,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: - - *63 + - *67 requestBody: required: true content: @@ -16167,11 +16470,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the organization. - items: *102 + items: *108 required: - properties examples: - default: &566 + default: &570 value: properties: - property_name: environment @@ -16207,7 +16510,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#get-all-budgets-for-an-organization parameters: - - *63 + - *67 + - *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 @@ -16283,6 +16604,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: @@ -16324,7 +16649,7 @@ paths: alert_recipients: [] '404': *6 '403': *29 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16345,8 +16670,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#get-a-budget-by-id-for-an-organization parameters: - - *63 - - &105 + - *67 + - &111 name: budget_id description: The ID corresponding to the budget. in: path @@ -16439,8 +16764,8 @@ paths: '400': *14 '404': *6 '403': *29 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16460,8 +16785,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#update-a-budget-for-an-organization parameters: - - *63 - - *105 + - *67 + - *111 requestBody: required: true content: @@ -16585,7 +16910,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': *25 '403': *29 @@ -16634,8 +16971,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization parameters: - - *63 - - *105 + - *67 + - *111 responses: '200': description: Response when deleting a budget @@ -16661,8 +16998,8 @@ paths: '400': *14 '404': *6 '403': *29 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16682,8 +17019,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-an-organization parameters: - - *63 - - &106 + - *67 + - &112 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, @@ -16692,7 +17029,7 @@ paths: required: false schema: type: integer - - &108 + - &114 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 @@ -16701,7 +17038,7 @@ paths: required: false schema: type: integer - - &107 + - &113 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 @@ -16716,14 +17053,14 @@ paths: required: false schema: type: string - - &702 + - &713 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &109 + - &115 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -16839,8 +17176,8 @@ paths: '400': *14 '403': *29 '404': *6 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16860,9 +17197,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-an-organization parameters: - - *63 - - *106 - - &703 + - *67 + - *112 + - &714 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 @@ -16871,7 +17208,7 @@ paths: required: false schema: type: integer - - *107 + - *113 responses: '200': description: Billing usage report response for an organization @@ -16946,8 +17283,8 @@ paths: repositoryName: github/example '400': *14 '403': *29 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16970,19 +17307,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-an-organization parameters: - - *63 - - *106 - - *108 - - *107 - - &704 + - *67 + - *112 + - *114 + - *113 + - &715 name: repository description: The repository name to query for usage in the format owner/repository. in: query required: false schema: type: string - - *109 - - &705 + - *115 + - &716 name: sku description: The SKU to query for usage. in: query @@ -17092,8 +17429,8 @@ paths: netAmount: 8.0 '400': *14 '403': *29 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17119,13 +17456,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: &110 + schema: &116 title: Organization Full description: Organization Full type: object @@ -17444,7 +17781,7 @@ paths: - updated_at - archived_at examples: - default-response: &111 + default-response: &117 value: login: github id: 1 @@ -17544,7 +17881,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *63 + - *67 requestBody: required: false content: @@ -17760,18 +18097,18 @@ paths: description: Response content: application/json: - schema: *110 + schema: *116 examples: - default: *111 + default: *117 '422': description: Validation failed content: application/json: schema: oneOf: - - *112 - - *113 - '409': *47 + - *118 + - *119 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17794,7 +18131,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *63 + - *67 responses: '202': *39 '404': *6 @@ -17819,7 +18156,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response @@ -17845,7 +18182,7 @@ paths: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17866,7 +18203,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: - - *63 + - *67 - *17 - *19 responses: @@ -17884,7 +18221,7 @@ paths: type: integer repository_cache_usages: type: array - items: &339 + items: &343 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -17919,7 +18256,7 @@ paths: active_caches_size_in_bytes: 1022142 active_caches_count: 2 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17939,7 +18276,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *63 + - *67 - *17 - *19 responses: @@ -17957,7 +18294,7 @@ paths: type: integer runners: type: array - items: &114 + items: &120 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -18011,7 +18348,7 @@ paths: - display_name - source nullable: true - machine_size_details: &122 + machine_size_details: &128 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -18107,7 +18444,7 @@ paths: - public_ip_enabled - platform examples: - default: &142 + default: &148 value: total_count: 2 runners: @@ -18149,7 +18486,7 @@ paths: public_ips: [] last_active_on: '2023-04-26T15:23:37Z' headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18167,7 +18504,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - - *63 + - *67 requestBody: required: true content: @@ -18244,9 +18581,9 @@ paths: description: Response content: application/json: - schema: *114 + schema: *120 examples: - default: &123 + default: &129 value: id: 5 name: My hosted ubuntu runner @@ -18287,7 +18624,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response @@ -18303,7 +18640,7 @@ paths: type: integer images: type: array - items: &115 + items: &121 title: GitHub-hosted runner custom image details description: Provides details of a custom runner image type: object @@ -18354,7 +18691,7 @@ paths: - latest_version - state examples: - default: &117 + default: &123 value: total_count: 2 image_versions: @@ -18385,8 +18722,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: - - *63 - - &116 + - *67 + - &122 name: image_definition_id description: Image definition ID of custom image in: path @@ -18398,7 +18735,7 @@ paths: description: Response content: application/json: - schema: *115 + schema: *121 examples: default: value: @@ -18428,8 +18765,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization parameters: - - *63 - - *116 + - *67 + - *122 responses: '204': description: Response @@ -18452,8 +18789,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: - - *116 - - *63 + - *122 + - *67 responses: '200': description: Response @@ -18469,7 +18806,7 @@ paths: type: integer image_versions: type: array - items: &118 + items: &124 title: GitHub-hosted runner custom image version details. description: Provides details of a hosted runner custom image version @@ -18502,7 +18839,7 @@ paths: - created_on - state_details examples: - default: *117 + default: *123 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18522,9 +18859,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: - - *63 - - *116 - - &119 + - *67 + - *122 + - &125 name: version description: Version of a custom image in: path @@ -18537,7 +18874,7 @@ paths: description: Response content: application/json: - schema: *118 + schema: *124 examples: default: value: @@ -18563,9 +18900,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: - - *63 - - *116 - - *119 + - *67 + - *122 + - *125 responses: '204': description: Response @@ -18586,7 +18923,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: - - *63 + - *67 responses: '200': description: Response @@ -18602,7 +18939,7 @@ paths: type: integer images: type: array - items: &120 + items: &126 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -18638,7 +18975,7 @@ paths: - display_name - source examples: - default: &121 + default: &127 value: id: ubuntu-20.04 platform: linux-x64 @@ -18662,7 +18999,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: - - *63 + - *67 responses: '200': description: Response @@ -18678,9 +19015,9 @@ paths: type: integer images: type: array - items: *120 + items: *126 examples: - default: *121 + default: *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18697,7 +19034,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: - - *63 + - *67 responses: '200': description: Response @@ -18750,7 +19087,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: - - *63 + - *67 responses: '200': description: Response @@ -18766,7 +19103,7 @@ paths: type: integer machine_specs: type: array - items: *122 + items: *128 examples: default: value: @@ -18791,7 +19128,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: - - *63 + - *67 responses: '200': description: Response @@ -18835,8 +19172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - - *63 - - &124 + - *67 + - &130 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -18848,11 +19185,11 @@ paths: description: Response content: application/json: - schema: *114 + schema: *120 examples: - default: *123 + default: *129 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18870,8 +19207,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *63 - - *124 + - *67 + - *130 requestBody: required: true content: @@ -18914,9 +19251,9 @@ paths: description: Response content: application/json: - schema: *114 + schema: *120 examples: - default: *123 + default: *129 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -18932,16 +19269,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *63 - - *124 + - *67 + - *130 responses: '202': description: Response content: application/json: - schema: *114 + schema: *120 examples: - default: *123 + default: *129 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -18961,13 +19298,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: - - *63 + - *67 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &125 + schema: &131 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -18981,7 +19318,7 @@ paths: required: - include_claim_keys examples: - default: &126 + default: &132 value: include_claim_keys: - repo @@ -19003,20 +19340,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: - - *63 + - *67 requestBody: required: true content: application/json: - schema: *125 + schema: *131 examples: - default: *126 + default: *132 responses: '201': description: Empty response content: application/json: - schema: &152 + schema: &158 title: Empty Object description: An object without any properties. type: object @@ -19046,7 +19383,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response @@ -19055,7 +19392,7 @@ paths: schema: type: object properties: - enabled_repositories: &127 + enabled_repositories: &133 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -19068,7 +19405,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: &128 + allowed_actions: &134 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -19076,12 +19413,12 @@ paths: - all - local_only - selected - selected_actions_url: &345 + selected_actions_url: &349 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: &129 + sha_pinning_required: &135 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -19112,7 +19449,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *63 + - *67 responses: '204': description: Response @@ -19123,9 +19460,9 @@ paths: schema: type: object properties: - enabled_repositories: *127 - allowed_actions: *128 - sha_pinning_required: *129 + enabled_repositories: *133 + allowed_actions: *134 + sha_pinning_required: *135 required: - enabled_repositories examples: @@ -19153,13 +19490,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: &349 + schema: &353 type: object properties: days: @@ -19196,12 +19533,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization parameters: - - *63 + - *67 requestBody: required: true content: application/json: - schema: &350 + schema: &354 type: object properties: days: @@ -19218,7 +19555,7 @@ paths: description: No content '403': *29 '404': *6 - '409': *47 + '409': *51 '422': *15 x-github: enabledForGitHubApps: true @@ -19238,13 +19575,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: &130 + schema: &136 type: object properties: approval_policy: @@ -19258,7 +19595,7 @@ paths: required: - approval_policy examples: - default: &351 + default: &355 value: approval_policy: first_time_contributors '404': *6 @@ -19279,7 +19616,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *63 + - *67 responses: '204': description: Response @@ -19289,7 +19626,7 @@ paths: required: true content: application/json: - schema: *130 + schema: *136 examples: default: summary: Set approval policy to first time contributors @@ -19311,13 +19648,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: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: &352 + schema: &356 type: object required: - run_workflows_from_fork_pull_requests @@ -19343,7 +19680,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &131 + default: &137 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -19366,12 +19703,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: - - *63 + - *67 requestBody: required: true content: application/json: - schema: &353 + schema: &357 type: object required: - run_workflows_from_fork_pull_requests @@ -19394,7 +19731,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *131 + default: *137 responses: '204': description: Empty response for successful settings update @@ -19424,7 +19761,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: - - *63 + - *67 - *17 - *19 responses: @@ -19442,9 +19779,9 @@ paths: type: number repositories: type: array - items: *66 + items: *70 examples: - default: &135 + default: &141 value: total_count: 1 repositories: @@ -19584,7 +19921,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: - - *63 + - *67 responses: '204': description: Response @@ -19628,8 +19965,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: - - *63 - - &132 + - *67 + - &138 name: repository_id description: The unique identifier of the repository. in: path @@ -19657,8 +19994,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: - - *63 - - *132 + - *67 + - *138 responses: '204': description: Response @@ -19681,13 +20018,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: &133 + schema: &139 type: object properties: github_owned_allowed: @@ -19709,7 +20046,7 @@ paths: items: type: string examples: - default: &134 + default: &140 value: github_owned_allowed: true verified_allowed: false @@ -19734,7 +20071,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *63 + - *67 responses: '204': description: Response @@ -19742,9 +20079,9 @@ paths: required: false content: application/json: - schema: *133 + schema: *139 examples: - selected_actions: *134 + selected_actions: *140 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -19764,7 +20101,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response @@ -19812,7 +20149,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization parameters: - - *63 + - *67 requestBody: required: true content: @@ -19839,7 +20176,7 @@ paths: description: No content '403': *29 '404': *6 - '409': *47 + '409': *51 '422': *15 x-github: enabledForGitHubApps: true @@ -19859,7 +20196,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: - - *63 + - *67 - *17 - *19 responses: @@ -19874,9 +20211,9 @@ paths: type: integer repositories: type: array - items: *66 + items: *70 examples: - default: *135 + default: *141 '403': *29 '404': *6 x-github: @@ -19896,7 +20233,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: - - *63 + - *67 requestBody: required: true content: @@ -19944,14 +20281,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: - - *63 - - *132 + - *67 + - *138 responses: '204': description: No content '403': *29 '404': *6 - '409': *47 + '409': *51 '422': *15 x-github: enabledForGitHubApps: true @@ -19971,14 +20308,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: - - *63 - - *132 + - *67 + - *138 responses: '204': description: No content '403': *29 '404': *6 - '409': *47 + '409': *51 '422': *15 x-github: enabledForGitHubApps: true @@ -20000,23 +20337,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: &354 + schema: &358 type: object properties: - default_workflow_permissions: &136 + default_workflow_permissions: &142 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &137 + can_approve_pull_request_reviews: &143 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -20024,7 +20361,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &138 + default: &144 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -20049,7 +20386,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *63 + - *67 responses: '204': description: Success response @@ -20057,13 +20394,13 @@ paths: required: false content: application/json: - schema: &355 + schema: &359 type: object properties: - default_workflow_permissions: *136 - can_approve_pull_request_reviews: *137 + default_workflow_permissions: *142 + can_approve_pull_request_reviews: *143 examples: - default: *138 + default: *144 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20083,7 +20420,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: - - *63 + - *67 - *17 - *19 - name: visible_to_repository @@ -20108,7 +20445,7 @@ paths: type: number runner_groups: type: array - items: &139 + items: &145 type: object properties: id: @@ -20224,7 +20561,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: - - *63 + - *67 requestBody: required: true content: @@ -20296,9 +20633,9 @@ paths: description: Response content: application/json: - schema: *139 + schema: *145 examples: - default: &141 + default: &147 value: id: 2 name: octo-runner-group @@ -20333,8 +20670,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: - - *63 - - &140 + - *67 + - &146 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -20346,7 +20683,7 @@ paths: description: Response content: application/json: - schema: *139 + schema: *145 examples: default: value: @@ -20382,8 +20719,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: - - *63 - - *140 + - *67 + - *146 requestBody: required: true content: @@ -20437,9 +20774,9 @@ paths: description: Response content: application/json: - schema: *139 + schema: *145 examples: - default: *141 + default: *147 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -20458,8 +20795,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: - - *63 - - *140 + - *67 + - *146 responses: '204': description: Response @@ -20482,8 +20819,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: - - *63 - - *140 + - *67 + - *146 - *17 - *19 responses: @@ -20501,11 +20838,11 @@ paths: type: number runners: type: array - items: *114 + items: *120 examples: - default: *142 + default: *148 headers: - Link: *54 + Link: *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -20525,8 +20862,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: - - *63 - - *140 + - *67 + - *146 - *19 - *17 responses: @@ -20544,9 +20881,9 @@ paths: type: number repositories: type: array - items: *143 + items: *149 examples: - default: &666 + default: &668 value: total_count: 1 repositories: @@ -20798,8 +21135,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: - - *63 - - *140 + - *67 + - *146 requestBody: required: true content: @@ -20843,9 +21180,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: - - *63 - - *140 - - *132 + - *67 + - *146 + - *138 responses: '204': description: Response @@ -20867,9 +21204,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: - - *63 - - *140 - - *132 + - *67 + - *146 + - *138 responses: '204': description: Response @@ -20892,8 +21229,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: - - *63 - - *140 + - *67 + - *146 - *17 - *19 responses: @@ -20911,7 +21248,7 @@ paths: type: number runners: type: array - items: &145 + items: &151 title: Self hosted runners description: A self hosted runner type: object @@ -20940,7 +21277,7 @@ paths: type: boolean labels: type: array - items: &148 + items: &154 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -20970,7 +21307,7 @@ paths: - busy - labels examples: - default: &146 + default: &152 value: total_count: 2 runners: @@ -21010,7 +21347,7 @@ paths: name: no-gpu type: custom headers: - Link: *54 + Link: *58 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21029,8 +21366,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: - - *63 - - *140 + - *67 + - *146 requestBody: required: true content: @@ -21074,9 +21411,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: - - *63 - - *140 - - &144 + - *67 + - *146 + - &150 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -21104,9 +21441,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: - - *63 - - *140 - - *144 + - *67 + - *146 + - *150 responses: '204': description: Response @@ -21136,7 +21473,7 @@ paths: in: query schema: type: string - - *63 + - *67 - *17 - *19 responses: @@ -21154,11 +21491,11 @@ paths: type: integer runners: type: array - items: *145 + items: *151 examples: - default: *146 + default: *152 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21180,7 +21517,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response @@ -21188,7 +21525,7 @@ paths: application/json: schema: type: array - items: &356 + items: &360 title: Runner Application description: Runner Application type: object @@ -21213,7 +21550,7 @@ paths: - download_url - filename examples: - default: &357 + default: &361 value: - os: osx architecture: x64 @@ -21256,7 +21593,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: - - *63 + - *67 requestBody: required: true content: @@ -21299,7 +21636,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &358 + '201': &362 description: Response content: application/json: @@ -21309,7 +21646,7 @@ paths: - runner - encoded_jit_config properties: - runner: *145 + runner: *151 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -21338,7 +21675,7 @@ paths: encoded_jit_config: abc123 '404': *6 '422': *7 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21366,13 +21703,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *63 + - *67 responses: '201': description: Response content: application/json: - schema: &147 + schema: &153 title: Authentication Token description: Authentication Token type: object @@ -21394,7 +21731,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *66 + items: *70 single_file: type: string example: config.yaml @@ -21410,7 +21747,7 @@ paths: - token - expires_at examples: - default: &359 + default: &363 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -21441,15 +21778,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *63 + - *67 responses: '201': description: Response content: application/json: - schema: *147 + schema: *153 examples: - default: &360 + default: &364 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -21474,16 +21811,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: - - *63 - - *144 + - *67 + - *150 responses: '200': description: Response content: application/json: - schema: *145 + schema: *151 examples: - default: &361 + default: &365 value: id: 23 name: MBP @@ -21524,8 +21861,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: - - *63 - - *144 + - *67 + - *150 responses: '204': description: Response @@ -21551,10 +21888,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: - - *63 - - *144 + - *67 + - *150 responses: - '200': &149 + '200': &155 description: Response content: application/json: @@ -21568,7 +21905,7 @@ paths: type: integer labels: type: array - items: *148 + items: *154 examples: default: value: @@ -21607,8 +21944,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: - - *63 - - *144 + - *67 + - *150 requestBody: required: true content: @@ -21632,7 +21969,7 @@ paths: - gpu - accelerated responses: - '200': *149 + '200': *155 '404': *6 '422': *7 x-github: @@ -21656,8 +21993,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: - - *63 - - *144 + - *67 + - *150 requestBody: required: true content: @@ -21682,7 +22019,7 @@ paths: - gpu - accelerated responses: - '200': *149 + '200': *155 '404': *6 '422': *7 x-github: @@ -21706,10 +22043,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: - - *63 - - *144 + - *67 + - *150 responses: - '200': &362 + '200': &366 description: Response content: application/json: @@ -21723,7 +22060,7 @@ paths: type: integer labels: type: array - items: *148 + items: *154 examples: default: value: @@ -21764,9 +22101,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: - - *63 - - *144 - - &363 + - *67 + - *150 + - &367 name: name description: The name of a self-hosted runner's custom label. in: path @@ -21774,7 +22111,7 @@ paths: schema: type: string responses: - '200': *149 + '200': *155 '404': *6 '422': *7 x-github: @@ -21799,7 +22136,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *63 + - *67 - *17 - *19 responses: @@ -21817,7 +22154,7 @@ paths: type: integer secrets: type: array - items: &150 + items: &156 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -21867,7 +22204,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21890,13 +22227,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: &375 + schema: &379 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -21925,7 +22262,7 @@ paths: - key_id - key examples: - default: &376 + default: &380 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -21950,8 +22287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *63 - - &151 + - *67 + - &157 name: secret_name description: The name of the secret. in: path @@ -21963,7 +22300,7 @@ paths: description: Response content: application/json: - schema: *150 + schema: *156 examples: default: value: @@ -21993,8 +22330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 requestBody: required: true content: @@ -22051,7 +22388,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -22077,8 +22414,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 responses: '204': description: Response @@ -22104,8 +22441,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 - *19 - *17 responses: @@ -22123,9 +22460,9 @@ paths: type: integer repositories: type: array - items: *143 + items: *149 examples: - default: &155 + default: &161 value: total_count: 1 repositories: @@ -22217,8 +22554,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 requestBody: required: true content: @@ -22270,8 +22607,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 - name: repository_id in: path required: true @@ -22304,8 +22641,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 - name: repository_id in: path required: true @@ -22337,8 +22674,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *63 - - &344 + - *67 + - &348 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)." @@ -22362,7 +22699,7 @@ paths: type: integer variables: type: array - items: &153 + items: &159 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -22426,7 +22763,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22447,7 +22784,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *63 + - *67 requestBody: required: true content: @@ -22495,7 +22832,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -22520,8 +22857,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *63 - - &154 + - *67 + - &160 name: name description: The name of the variable. in: path @@ -22533,7 +22870,7 @@ paths: description: Response content: application/json: - schema: *153 + schema: *159 examples: default: value: @@ -22563,8 +22900,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *63 - - *154 + - *67 + - *160 requestBody: required: true content: @@ -22626,8 +22963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *63 - - *154 + - *67 + - *160 responses: '204': description: Response @@ -22653,8 +22990,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *63 - - *154 + - *67 + - *160 - *19 - *17 responses: @@ -22672,9 +23009,9 @@ paths: type: integer repositories: type: array - items: *143 + items: *149 examples: - default: *155 + default: *161 '409': description: Response when the visibility of the variable is not set to `selected` @@ -22700,8 +23037,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *63 - - *154 + - *67 + - *160 requestBody: required: true content: @@ -22750,8 +23087,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *63 - - *154 + - *67 + - *160 - name: repository_id in: path required: true @@ -22785,8 +23122,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *63 - - *154 + - *67 + - *160 - name: repository_id in: path required: true @@ -22816,7 +23153,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#create-an-artifact-deployment-record parameters: - - *63 + - *67 requestBody: required: true content: @@ -22923,7 +23260,7 @@ paths: type: integer deployment_records: type: array - items: &156 + items: &162 title: Artifact Deployment Record description: Artifact Metadata Deployment Record type: object @@ -22967,7 +23304,7 @@ paths: with the deployment record. nullable: true examples: - default: &157 + default: &163 value: total_count: 1 deployment_records: @@ -22998,7 +23335,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records parameters: - - *63 + - *67 - name: cluster in: path description: The cluster name. @@ -23113,9 +23450,9 @@ paths: type: integer deployment_records: type: array - items: *156 + items: *162 examples: - default: *157 + default: *163 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23135,7 +23472,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - - *63 + - *67 requestBody: required: true content: @@ -23286,7 +23623,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-deployment-records parameters: - - *63 + - *67 - name: subject_digest description: The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. in: path @@ -23311,9 +23648,9 @@ paths: type: integer deployment_records: type: array - items: *156 + items: *162 examples: - default: *157 + default: *163 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23333,7 +23670,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - - *63 + - *67 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -23416,9 +23753,9 @@ paths: url: https://docs.github.com/rest/orgs/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *40 - - *41 - - *63 + - *45 + - *46 + - *67 requestBody: required: true content: @@ -23442,12 +23779,12 @@ paths: required: - subject_digests examples: - default: &694 + default: &696 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &695 + withPredicateType: &697 value: subject_digests: - sha256:abc123 @@ -23505,7 +23842,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &696 + default: &698 value: attestations_subject_digests: - sha256:abc: @@ -23614,7 +23951,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *63 + - *67 requestBody: required: true content: @@ -23679,7 +24016,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *63 + - *67 - name: subject_digest description: Subject Digest in: path @@ -23712,9 +24049,9 @@ paths: url: https://docs.github.com/rest/orgs/attestations#list-attestation-repositories parameters: - *17 - - *40 - - *41 - - *63 + - *45 + - *46 + - *67 - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. @@ -23762,7 +24099,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id parameters: - - *63 + - *67 - name: attestation_id description: Attestation ID in: path @@ -23798,9 +24135,9 @@ paths: url: https://docs.github.com/rest/orgs/attestations#list-attestations parameters: - *17 - - *40 - - *41 - - *63 + - *45 + - *46 + - *67 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -23854,7 +24191,7 @@ paths: initiator: type: string examples: - default: &389 + default: &393 value: attestations: - bundle: @@ -23961,7 +24298,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *63 + - *67 - *17 - *19 responses: @@ -23973,7 +24310,7 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23992,8 +24329,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: + - *67 - *63 - - *59 responses: '204': description: If the user is blocked @@ -24018,8 +24355,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: + - *67 - *63 - - *59 responses: '204': description: Response @@ -24039,8 +24376,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: + - *67 - *63 - - *59 responses: '204': description: Response @@ -24065,15 +24402,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *63 + - *67 - *19 - *17 - - *48 + - *52 - name: state description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &158 + schema: &164 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -24099,7 +24436,7 @@ paths: application/json: schema: type: array - items: &159 + items: &165 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -24130,7 +24467,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &181 + items: &187 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -24205,7 +24542,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &234 + properties: &240 id: description: Unique identifier of the team type: integer @@ -24277,7 +24614,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &235 + required: &241 - id - node_id - url @@ -24320,7 +24657,7 @@ paths: type: string format: date-time nullable: true - state: *158 + state: *164 contact_link: description: The contact link of the campaign. type: string @@ -24415,9 +24752,9 @@ paths: closed_at: state: open headers: - Link: *54 + Link: *58 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24441,7 +24778,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *63 + - *67 requestBody: required: true content: @@ -24540,9 +24877,9 @@ paths: description: Response content: application/json: - schema: *159 + schema: *165 examples: - default: &160 + default: &166 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -24591,7 +24928,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24613,7 +24950,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *63 + - *67 - name: campaign_number description: The campaign number. in: path @@ -24625,16 +24962,16 @@ paths: description: Response content: application/json: - schema: *159 + schema: *165 examples: - default: *160 + default: *166 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24655,7 +24992,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign parameters: - - *63 + - *67 - name: campaign_number description: The campaign number. in: path @@ -24704,7 +25041,7 @@ paths: type: string format: uri nullable: true - state: *158 + state: *164 examples: default: value: @@ -24714,9 +25051,9 @@ paths: description: Response content: application/json: - schema: *159 + schema: *165 examples: - default: *160 + default: *166 '400': description: Bad Request content: @@ -24728,7 +25065,7 @@ paths: content: application/json: schema: *3 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24749,7 +25086,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *63 + - *67 - name: campaign_number description: The campaign number. in: path @@ -24760,7 +25097,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24782,18 +25119,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *63 - - &415 + - *67 + - &419 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: &168 + schema: &174 type: string description: The name of the tool used to generate the code scanning analysis. - - &416 + - &420 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 @@ -24801,22 +25138,22 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &169 + schema: &175 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. - - *40 - - *41 + - *45 + - *46 - *19 - *17 - - *48 + - *52 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: &418 + schema: &422 type: string description: State of a code scanning alert. enum: @@ -24839,7 +25176,7 @@ paths: be returned. in: query required: false - schema: &419 + schema: &423 type: string description: Severity of a code scanning alert. enum: @@ -24860,18 +25197,18 @@ paths: items: type: object properties: - number: *161 - created_at: *162 - updated_at: *163 - url: *164 - html_url: *165 - instances_url: &420 + number: *167 + created_at: *168 + updated_at: *169 + url: *170 + html_url: *171 + instances_url: &424 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &170 + state: &176 type: string description: State of a code scanning alert. nullable: true @@ -24879,7 +25216,7 @@ paths: - open - dismissed - fixed - fixed_at: *166 + fixed_at: *172 dismissed_by: title: Simple User description: A GitHub user. @@ -24887,8 +25224,8 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *167 - dismissed_reason: &421 + dismissed_at: *173 + dismissed_reason: &425 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -24897,13 +25234,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &422 + dismissed_comment: &426 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &423 + rule: &427 type: object properties: id: @@ -24956,25 +25293,25 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &424 + tool: &428 type: object properties: - name: *168 + name: *174 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *169 - most_recent_instance: &425 + guid: *175 + most_recent_instance: &429 type: object properties: - ref: &417 + ref: &421 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &435 + analysis_key: &439 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -24985,13 +25322,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &436 + category: &440 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: *170 + state: *176 commit_sha: type: string message: @@ -25030,7 +25367,7 @@ paths: - generated - test - library - repository: *53 + repository: *57 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -25285,9 +25622,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: *54 + Link: *58 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25309,7 +25646,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *63 + - *67 - name: target_type in: query description: The target type of the code security configuration @@ -25328,8 +25665,8 @@ paths: schema: type: integer default: 30 - - *40 - - *41 + - *45 + - *46 responses: '200': description: Response @@ -25337,7 +25674,7 @@ paths: application/json: schema: type: array - items: *43 + items: *47 examples: default: value: @@ -25420,7 +25757,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *63 + - *67 requestBody: required: true content: @@ -25498,7 +25835,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *171 + code_scanning_options: *177 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -25507,7 +25844,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: *46 + code_scanning_default_setup_options: *50 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -25639,9 +25976,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *43 + schema: *47 examples: - default: *172 + default: *178 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25663,15 +26000,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: *173 + schema: *179 examples: - default: *174 + default: *180 '304': *37 '403': *29 '404': *6 @@ -25697,7 +26034,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *63 + - *67 requestBody: required: true content: @@ -25723,11 +26060,11 @@ paths: - 32 - 91 responses: - '204': *175 + '204': *181 '400': *14 '403': *29 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25749,16 +26086,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *63 - - *45 + - *67 + - *49 responses: '200': description: Response content: application/json: - schema: *43 + schema: *47 examples: - default: *172 + default: *178 '304': *37 '403': *29 '404': *6 @@ -25782,8 +26119,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *63 - - *45 + - *67 + - *49 requestBody: required: true content: @@ -25862,7 +26199,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *46 + code_scanning_default_setup_options: *50 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -25980,7 +26317,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *43 + schema: *47 examples: default: value: @@ -26039,14 +26376,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *63 - - *45 + - *67 + - *49 responses: - '204': *175 + '204': *181 '400': *14 '403': *29 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26070,8 +26407,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *63 - - *45 + - *67 + - *49 requestBody: required: true content: @@ -26134,8 +26471,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: - - *63 - - *45 + - *67 + - *49 requestBody: required: true content: @@ -26175,12 +26512,12 @@ paths: - none - private_and_internal - public - configuration: *43 + configuration: *47 examples: default: value: default_for_new_repos: all - configuration: *172 + configuration: *178 '403': *29 '404': *6 x-github: @@ -26204,8 +26541,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *63 - - *45 + - *67 + - *49 - 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)." @@ -26214,8 +26551,8 @@ paths: schema: type: integer default: 30 - - *40 - - *41 + - *45 + - *46 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -26233,13 +26570,13 @@ paths: application/json: schema: type: array - items: *176 + items: *182 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *177 + repository: *183 '403': *29 '404': *6 x-github: @@ -26263,7 +26600,7 @@ paths: parameters: - *17 - *19 - - *63 + - *67 responses: '200': description: Response @@ -26279,7 +26616,7 @@ paths: type: integer codespaces: type: array - items: &224 + items: &230 type: object title: Codespace description: A codespace. @@ -26304,12 +26641,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *143 + repository: *149 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &448 + properties: &452 name: type: string description: The name of the machine. @@ -26351,7 +26688,7 @@ paths: - ready - in_progress nullable: true - required: &449 + required: &453 - name - display_name - operating_system @@ -26556,7 +26893,7 @@ paths: - pulls_url - recent_folders examples: - default: &225 + default: &231 value: total_count: 3 codespaces: @@ -26966,7 +27303,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *37 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -26988,7 +27325,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *63 + - *67 deprecated: true requestBody: required: true @@ -27032,7 +27369,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27055,7 +27392,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *63 + - *67 deprecated: true requestBody: required: true @@ -27087,7 +27424,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27110,7 +27447,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *63 + - *67 requestBody: required: true content: @@ -27141,7 +27478,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27162,7 +27499,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *63 + - *67 - *17 - *19 responses: @@ -27180,7 +27517,7 @@ paths: type: integer secrets: type: array - items: &178 + items: &184 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -27219,7 +27556,7 @@ paths: - updated_at - visibility examples: - default: &450 + default: &454 value: total_count: 2 secrets: @@ -27232,7 +27569,7 @@ paths: updated_at: '2020-01-11T11:59:22Z' visibility: all headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27251,13 +27588,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: &451 + schema: &455 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -27286,7 +27623,7 @@ paths: - key_id - key examples: - default: &452 + default: &456 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -27309,23 +27646,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 responses: '200': description: Response content: application/json: - schema: *178 + schema: *184 examples: - default: &454 + default: &458 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27345,8 +27682,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 requestBody: required: true content: @@ -27401,7 +27738,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -27427,8 +27764,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 responses: '204': description: Response @@ -27453,8 +27790,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 - *19 - *17 responses: @@ -27472,9 +27809,9 @@ paths: type: integer repositories: type: array - items: *143 + items: *149 examples: - default: *155 + default: *161 '404': *6 x-github: githubCloudOnly: false @@ -27496,8 +27833,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 requestBody: required: true content: @@ -27547,8 +27884,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 - name: repository_id in: path required: true @@ -27581,8 +27918,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 - name: repository_id in: path required: true @@ -27621,7 +27958,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: - - *63 + - *67 responses: '200': description: OK @@ -27730,7 +28067,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -27762,7 +28099,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: - - *63 + - *67 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -27785,7 +28122,7 @@ paths: currently being billed. seats: type: array - items: &227 + items: &233 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -27802,15 +28139,15 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *179 - required: *180 + properties: *185 + required: *186 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *181 - - *55 + - *187 + - *59 nullable: true pending_cancellation_date: type: string @@ -27934,8 +28271,8 @@ paths: type: User site_admin: false headers: - Link: *54 - '500': *103 + Link: *58 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -27968,7 +28305,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: - - *63 + - *67 requestBody: content: application/json: @@ -28010,7 +28347,7 @@ paths: default: value: seats_created: 5 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -28046,7 +28383,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: - - *63 + - *67 requestBody: content: application/json: @@ -28088,7 +28425,7 @@ paths: default: value: seats_cancelled: 5 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -28126,7 +28463,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: - - *63 + - *67 requestBody: content: application/json: @@ -28167,7 +28504,7 @@ paths: default: value: seats_created: 5 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -28203,7 +28540,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: - - *63 + - *67 requestBody: content: application/json: @@ -28245,7 +28582,7 @@ paths: default: value: seats_cancelled: 5 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -28284,7 +28621,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *63 + - *67 - 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`). @@ -28316,7 +28653,7 @@ paths: application/json: schema: type: array - items: &309 + items: &316 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -28623,7 +28960,7 @@ paths: - date additionalProperties: true examples: - default: &310 + default: &317 value: - date: '2024-06-24' total_active_users: 24 @@ -28722,10 +29059,10 @@ paths: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - '500': *103 + '500': *109 '403': *29 '404': *6 - '422': &311 + '422': &318 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -28752,12 +29089,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *63 - - *182 - - *183 - - *184 - - *185 - - *186 + - *67 + - *188 + - *189 + - *190 + - *191 + - *192 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -28795,11 +29132,11 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *187 - - *188 - - *48 - - *40 - - *41 + - *193 + - *194 + - *52 + - *45 + - *46 - *17 responses: '200': @@ -28808,9 +29145,9 @@ paths: application/json: schema: type: array - items: *189 + items: *195 examples: - default: *190 + default: *196 '304': *37 '400': *14 '403': *29 @@ -28836,7 +29173,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *63 + - *67 - *17 - *19 responses: @@ -28854,7 +29191,7 @@ paths: type: integer secrets: type: array - items: &191 + items: &197 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -28904,7 +29241,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28925,13 +29262,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: &480 + schema: &484 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -28948,7 +29285,7 @@ paths: - key_id - key examples: - default: &481 + default: &485 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -28971,14 +29308,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 responses: '200': description: Response content: application/json: - schema: *191 + schema: *197 examples: default: value: @@ -29006,8 +29343,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 requestBody: required: true content: @@ -29066,7 +29403,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -29090,8 +29427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 responses: '204': description: Response @@ -29115,8 +29452,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 - *19 - *17 responses: @@ -29134,9 +29471,9 @@ paths: type: integer repositories: type: array - items: *143 + items: *149 examples: - default: *155 + default: *161 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29157,8 +29494,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 requestBody: required: true content: @@ -29208,8 +29545,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 - name: repository_id in: path required: true @@ -29240,8 +29577,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *63 - - *151 + - *67 + - *157 - name: repository_id in: path required: true @@ -29271,7 +29608,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: - - *63 + - *67 responses: '200': description: Response @@ -29279,7 +29616,7 @@ paths: application/json: schema: type: array - items: &237 + items: &243 title: Package description: A software package type: object @@ -29329,8 +29666,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *192 - required: *193 + properties: *198 + required: *199 nullable: true created_at: type: string @@ -29349,7 +29686,7 @@ paths: - created_at - updated_at examples: - default: &238 + default: &244 value: - id: 197 name: hello_docker @@ -29427,7 +29764,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *63 + - *67 - *17 - *19 responses: @@ -29437,7 +29774,7 @@ paths: application/json: schema: type: array - items: *94 + items: *98 examples: 200-response: value: @@ -29509,7 +29846,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *63 + - *67 - *17 - *19 responses: @@ -29519,7 +29856,7 @@ paths: application/json: schema: type: array - items: &216 + items: &222 title: Organization Invitation description: Organization Invitation type: object @@ -29566,7 +29903,7 @@ paths: - invitation_teams_url - node_id examples: - default: &217 + default: &223 value: - id: 1 login: monalisa @@ -29599,7 +29936,7 @@ paths: invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams invitation_source: member headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -29623,7 +29960,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *63 + - *67 - *17 - *19 responses: @@ -29633,7 +29970,7 @@ paths: application/json: schema: type: array - items: &194 + items: &200 title: Org Hook description: Org Hook type: object @@ -29721,7 +30058,7 @@ paths: created_at: '2011-09-06T17:26:27Z' type: Organization headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -29744,7 +30081,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *63 + - *67 requestBody: required: true content: @@ -29804,9 +30141,9 @@ paths: description: Response content: application/json: - schema: *194 + schema: *200 examples: - default: &195 + default: &201 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -29853,8 +30190,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *63 - - &196 + - *67 + - &202 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. @@ -29867,9 +30204,9 @@ paths: description: Response content: application/json: - schema: *194 + schema: *200 examples: - default: *195 + default: *201 '404': *6 x-github: githubCloudOnly: false @@ -29896,8 +30233,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *63 - - *196 + - *67 + - *202 requestBody: required: false content: @@ -29942,7 +30279,7 @@ paths: description: Response content: application/json: - schema: *194 + schema: *200 examples: default: value: @@ -29983,8 +30320,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *63 - - *196 + - *67 + - *202 responses: '204': description: Response @@ -30011,8 +30348,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *63 - - *196 + - *67 + - *202 responses: '200': description: Response @@ -30042,8 +30379,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *63 - - *196 + - *67 + - *202 requestBody: required: false content: @@ -30093,10 +30430,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *63 - - *196 + - *67 + - *202 - *17 - - *197 + - *203 responses: '200': description: Response @@ -30104,9 +30441,9 @@ paths: application/json: schema: type: array - items: *198 + items: *204 examples: - default: *199 + default: *205 '400': *14 '422': *15 x-github: @@ -30131,17 +30468,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *63 - - *196 + - *67 + - *202 - *16 responses: '200': description: Response content: application/json: - schema: *200 + schema: *206 examples: - default: *201 + default: *207 '400': *14 '422': *15 x-github: @@ -30166,8 +30503,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *63 - - *196 + - *67 + - *202 - *16 responses: '202': *39 @@ -30196,8 +30533,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *63 - - *196 + - *67 + - *202 responses: '204': description: Response @@ -30219,8 +30556,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *63 - - &206 + - *67 + - &212 name: actor_type in: path description: The type of the actor @@ -30233,14 +30570,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &207 + - &213 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &202 + - &208 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`.' @@ -30248,7 +30585,7 @@ paths: required: true schema: type: string - - &203 + - &209 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) @@ -30259,7 +30596,7 @@ paths: type: string - *19 - *17 - - *48 + - *52 - name: sort description: The property to sort the results by. in: query @@ -30341,13 +30678,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - - *63 - - *202 - - *203 + - *67 + - *208 + - *209 - *19 - *17 - - *48 - - &212 + - *52 + - &218 name: sort description: The property to sort the results by. in: query @@ -30425,15 +30762,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - - *63 - - *202 - - *203 + - *67 + - *208 + - *209 responses: '200': description: Response content: application/json: - schema: &204 + schema: &210 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -30449,7 +30786,7 @@ paths: type: integer format: int64 examples: - default: &205 + default: &211 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -30469,24 +30806,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *63 - - &208 + - *67 + - &214 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *202 - - *203 + - *208 + - *209 responses: '200': description: Response content: application/json: - schema: *204 + schema: *210 examples: - default: *205 + default: *211 x-github: enabledForGitHubApps: true category: orgs @@ -30504,19 +30841,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *63 - - *202 - - *203 - - *206 - - *207 + - *67 + - *208 + - *209 + - *212 + - *213 responses: '200': description: Response content: application/json: - schema: *204 + schema: *210 examples: - default: *205 + default: *211 x-github: enabledForGitHubApps: true category: orgs @@ -30533,10 +30870,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - - *63 - - *202 - - *203 - - &209 + - *67 + - *208 + - *209 + - &215 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -30549,7 +30886,7 @@ paths: description: Response content: application/json: - schema: &210 + schema: &216 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -30565,7 +30902,7 @@ paths: type: integer format: int64 examples: - default: &211 + default: &217 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -30601,19 +30938,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - - *63 + - *67 + - *214 - *208 - - *202 - - *203 - *209 + - *215 responses: '200': description: Response content: application/json: - schema: *210 + schema: *216 examples: - default: *211 + default: *217 x-github: enabledForGitHubApps: true category: orgs @@ -30630,20 +30967,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *63 - - *206 - - *207 - - *202 - - *203 + - *67 + - *212 + - *213 + - *208 - *209 + - *215 responses: '200': description: Response content: application/json: - schema: *210 + schema: *216 examples: - default: *211 + default: *217 x-github: enabledForGitHubApps: true category: orgs @@ -30660,14 +30997,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - - *63 + - *67 + - *214 - *208 - - *202 - - *203 + - *209 - *19 - *17 - - *48 - - *212 + - *52 + - *218 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -30740,7 +31077,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *63 + - *67 responses: '200': description: Response @@ -30748,7 +31085,7 @@ paths: application/json: schema: *22 examples: - default: &519 + default: &523 value: id: 1 account: @@ -30817,7 +31154,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *63 + - *67 - *17 - *19 responses: @@ -30887,7 +31224,7 @@ paths: suspended_at: suspended_by: headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30906,7 +31243,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response @@ -30914,12 +31251,12 @@ paths: application/json: schema: anyOf: - - &214 + - &220 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &213 + limit: &219 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -30944,7 +31281,7 @@ paths: properties: {} additionalProperties: false examples: - default: &215 + default: &221 value: limit: collaborators_only origin: organization @@ -30968,18 +31305,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *63 + - *67 requestBody: required: true content: application/json: - schema: &520 + schema: &524 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *213 + limit: *219 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -31003,9 +31340,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *220 examples: - default: *215 + default: *221 '422': *15 x-github: githubCloudOnly: false @@ -31023,7 +31360,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *63 + - *67 responses: '204': description: Response @@ -31047,7 +31384,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *63 + - *67 - *17 - *19 - name: role @@ -31081,11 +31418,11 @@ paths: application/json: schema: type: array - items: *216 + items: *222 examples: - default: *217 + default: *223 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -31106,7 +31443,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *63 + - *67 requestBody: required: false content: @@ -31160,7 +31497,7 @@ paths: description: Response content: application/json: - schema: *216 + schema: *222 examples: default: value: @@ -31214,8 +31551,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *63 - - &218 + - *67 + - &224 name: invitation_id description: The unique identifier of the invitation. in: path @@ -31245,8 +31582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *63 - - *218 + - *67 + - *224 - *17 - *19 responses: @@ -31256,9 +31593,9 @@ paths: application/json: schema: type: array - items: *181 + items: *187 examples: - default: &236 + default: &242 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -31274,7 +31611,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -31293,7 +31630,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response @@ -31301,7 +31638,7 @@ paths: application/json: schema: type: array - items: *219 + items: *225 examples: default: value: @@ -31339,7 +31676,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *63 + - *67 requestBody: required: true content: @@ -31386,9 +31723,9 @@ paths: description: Response content: application/json: - schema: *219 + schema: *225 examples: - default: &220 + default: &226 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -31420,8 +31757,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *63 - - &221 + - *67 + - &227 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -31474,9 +31811,9 @@ paths: description: Response content: application/json: - schema: *219 + schema: *225 examples: - default: *220 + default: *226 '404': *6 '422': *7 x-github: @@ -31500,8 +31837,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *63 - - *221 + - *67 + - *227 responses: '204': description: Response @@ -31534,7 +31871,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *63 + - *67 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -31564,7 +31901,7 @@ paths: - closed - all default: open - - *222 + - *228 - name: type description: Can be the name of an issue type. in: query @@ -31582,8 +31919,8 @@ paths: - updated - comments default: created - - *48 - - *72 + - *52 + - *76 - *17 - *19 responses: @@ -31593,11 +31930,11 @@ paths: application/json: schema: type: array - items: *82 + items: *86 examples: - default: *223 + default: *229 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -31617,7 +31954,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *63 + - *67 - 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) @@ -31655,9 +31992,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 '422': *15 x-github: githubCloudOnly: false @@ -31675,8 +32012,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: + - *67 - *63 - - *59 responses: '204': description: Response if requester is an organization member and user is @@ -31710,8 +32047,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: + - *67 - *63 - - *59 responses: '204': description: Response @@ -31737,8 +32074,8 @@ paths: parameters: - *17 - *19 + - *67 - *63 - - *59 responses: '200': description: Response @@ -31754,11 +32091,11 @@ paths: type: integer codespaces: type: array - items: *224 + items: *230 examples: - default: *225 + default: *231 '304': *37 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -31781,9 +32118,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: + - *67 - *63 - - *59 - - &226 + - &232 name: codespace_name in: path required: true @@ -31793,7 +32130,7 @@ paths: responses: '202': *39 '304': *37 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -31816,17 +32153,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: + - *67 - *63 - - *59 - - *226 + - *232 responses: '200': description: Response content: application/json: - schema: *224 + schema: *230 examples: - default: &447 + default: &451 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -31968,7 +32305,7 @@ paths: recent_folders: [] template: '304': *37 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -31999,14 +32336,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: + - *67 - *63 - - *59 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *227 + schema: *233 examples: default: value: @@ -32050,7 +32387,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -32075,14 +32412,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: + - *67 - *63 - - *59 responses: '200': description: Response content: application/json: - schema: &228 + schema: &234 title: Org Membership description: Org Membership type: object @@ -32126,7 +32463,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *61 + organization: *65 user: title: Simple User description: A GitHub user. @@ -32149,7 +32486,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &229 + response-if-user-has-an-active-admin-membership-with-organization: &235 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -32217,8 +32554,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: + - *67 - *63 - - *59 requestBody: required: false content: @@ -32246,9 +32583,9 @@ paths: description: Response content: application/json: - schema: *228 + schema: *234 examples: - response-if-user-already-had-membership-with-organization: *229 + response-if-user-already-had-membership-with-organization: *235 '422': *15 '403': *29 x-github: @@ -32272,8 +32609,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: + - *67 - *63 - - *59 responses: '204': description: Response @@ -32298,7 +32635,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *63 + - *67 - *17 - *19 - name: exclude @@ -32319,7 +32656,7 @@ paths: application/json: schema: type: array - items: &230 + items: &236 title: Migration description: A migration. type: object @@ -32360,7 +32697,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *66 + items: *70 url: type: string format: uri @@ -32556,7 +32893,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -32572,7 +32909,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *63 + - *67 requestBody: required: true content: @@ -32648,7 +32985,7 @@ paths: description: Response content: application/json: - schema: *230 + schema: *236 examples: default: value: @@ -32826,8 +33163,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *63 - - &231 + - *67 + - &237 name: migration_id description: The unique identifier of the migration. in: path @@ -32854,7 +33191,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *230 + schema: *236 examples: default: value: @@ -33023,8 +33360,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *63 - - *231 + - *67 + - *237 responses: '302': description: Response @@ -33045,8 +33382,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *63 - - *231 + - *67 + - *237 responses: '204': description: Response @@ -33069,9 +33406,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *63 - - *231 - - &679 + - *67 + - *237 + - &681 name: repo_name description: repo_name parameter in: path @@ -33098,8 +33435,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *63 - - *231 + - *67 + - *237 - *17 - *19 responses: @@ -33109,9 +33446,9 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: &243 + default: &249 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -33222,7 +33559,7 @@ paths: secret_scanning_non_provider_patterns: status: disabled headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -33248,7 +33585,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response - list of organization roles @@ -33264,7 +33601,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &233 + items: &239 title: Organization Role description: Organization roles type: object @@ -33411,8 +33748,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *63 - - *64 + - *67 + - *68 responses: '204': description: Response @@ -33437,9 +33774,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *63 - - *64 - - &232 + - *67 + - *68 + - &238 name: role_id description: The unique identifier of the role. in: path @@ -33474,9 +33811,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *63 - - *64 - - *232 + - *67 + - *68 + - *238 responses: '204': description: Response @@ -33501,8 +33838,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: + - *67 - *63 - - *59 responses: '204': description: Response @@ -33527,9 +33864,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: + - *67 - *63 - - *59 - - *232 + - *238 responses: '204': description: Response @@ -33559,9 +33896,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: + - *67 - *63 - - *59 - - *232 + - *238 responses: '204': description: Response @@ -33589,14 +33926,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *63 - - *232 + - *67 + - *238 responses: '200': description: Response content: application/json: - schema: *233 + schema: *239 examples: default: value: @@ -33646,8 +33983,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: - - *63 - - *232 + - *67 + - *238 - *17 - *19 responses: @@ -33725,8 +34062,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *234 - required: *235 + properties: *240 + required: *241 nullable: true type: description: The ownership type of the team @@ -33758,9 +34095,9 @@ paths: - type - parent examples: - default: *236 + default: *242 headers: - Link: *54 + Link: *58 '404': description: Response if the organization or role does not exist. '422': @@ -33787,8 +34124,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: - - *63 - - *232 + - *67 + - *238 - *17 - *19 responses: @@ -33816,13 +34153,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &305 + items: &312 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *234 - required: *235 + properties: *240 + required: *241 name: nullable: true type: string @@ -33917,9 +34254,9 @@ paths: - type - url examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 '404': description: Response if the organization or role does not exist. '422': @@ -33941,7 +34278,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *63 + - *67 - 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) @@ -33968,9 +34305,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33993,8 +34330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: + - *67 - *63 - - *59 requestBody: required: false content: @@ -34051,8 +34388,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: + - *67 - *63 - - *59 responses: '204': description: Response @@ -34109,8 +34446,8 @@ paths: - docker - nuget - container - - *63 - - &680 + - *67 + - &682 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -34146,12 +34483,12 @@ paths: application/json: schema: type: array - items: *237 + items: *243 examples: - default: *238 + default: *244 '403': *29 '401': *25 - '400': &682 + '400': &684 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -34173,7 +34510,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &239 + - &245 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 @@ -34191,20 +34528,20 @@ paths: - docker - nuget - container - - &240 + - &246 name: package_name description: The name of the package. in: path required: true schema: type: string - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: *237 + schema: *243 examples: default: value: @@ -34256,9 +34593,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *239 - - *240 - - *63 + - *245 + - *246 + - *67 responses: '204': description: Response @@ -34290,9 +34627,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *239 - - *240 - - *63 + - *245 + - *246 + - *67 - name: token description: package token schema: @@ -34324,9 +34661,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: - - *239 - - *240 - - *63 + - *245 + - *246 + - *67 - *19 - *17 - name: state @@ -34346,7 +34683,7 @@ paths: application/json: schema: type: array - items: &241 + items: &247 title: Package Version description: A version of a software package type: object @@ -34471,10 +34808,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *239 - - *240 - - *63 - - &242 + - *245 + - *246 + - *67 + - &248 name: package_version_id description: Unique identifier of the package version. in: path @@ -34486,7 +34823,7 @@ paths: description: Response content: application/json: - schema: *241 + schema: *247 examples: default: value: @@ -34522,10 +34859,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *239 - - *240 - - *63 - - *242 + - *245 + - *246 + - *67 + - *248 responses: '204': description: Response @@ -34557,10 +34894,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *239 - - *240 - - *63 - - *242 + - *245 + - *246 + - *67 + - *248 responses: '204': description: Response @@ -34587,10 +34924,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: - - *63 + - *67 - *17 - *19 - - &244 + - &250 name: sort description: The property by which to sort the results. in: query @@ -34600,8 +34937,8 @@ paths: enum: - created_at default: created_at - - *48 - - &245 + - *52 + - &251 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -34612,7 +34949,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &246 + - &252 name: repository description: The name of the repository to use to filter the results. in: query @@ -34620,7 +34957,7 @@ paths: schema: type: string example: Hello-World - - &247 + - &253 name: permission description: The permission to use to filter the results. in: query @@ -34628,7 +34965,7 @@ paths: schema: type: string example: issues_read - - &248 + - &254 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) @@ -34638,7 +34975,7 @@ paths: schema: type: string format: date-time - - &249 + - &255 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) @@ -34648,7 +34985,7 @@ paths: schema: type: string format: date-time - - &250 + - &256 name: token_id description: The ID of the token in: query @@ -34660,7 +34997,7 @@ paths: type: string example: token_id[]=1,token_id[]=2 responses: - '500': *103 + '500': *109 '422': *15 '404': *6 '403': *29 @@ -34792,7 +35129,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34812,7 +35149,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: - - *63 + - *67 requestBody: required: true content: @@ -34853,7 +35190,7 @@ paths: action: deny reason: Access is too broad. responses: - '500': *103 + '500': *109 '422': *15 '404': *6 '403': *29 @@ -34878,7 +35215,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: - - *63 + - *67 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -34914,11 +35251,11 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *103 + '500': *109 '422': *15 '404': *6 '403': *29 - '204': *175 + '204': *181 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34939,7 +35276,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: - - *63 + - *67 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -34950,7 +35287,7 @@ paths: - *17 - *19 responses: - '500': *103 + '500': *109 '404': *6 '403': *29 '200': @@ -34959,11 +35296,11 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: *243 + default: *249 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34984,19 +35321,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: - - *63 + - *67 - *17 - *19 - - *244 - - *48 - - *245 - - *246 - - *247 - - *248 - - *249 - *250 + - *52 + - *251 + - *252 + - *253 + - *254 + - *255 + - *256 responses: - '500': *103 + '500': *109 '422': *15 '404': *6 '403': *29 @@ -35123,7 +35460,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35143,7 +35480,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: - - *63 + - *67 requestBody: required: true content: @@ -35178,7 +35515,7 @@ paths: - 1296269 - 1296280 responses: - '500': *103 + '500': *109 '404': *6 '202': *39 '403': *29 @@ -35203,7 +35540,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: - - *63 + - *67 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -35231,9 +35568,9 @@ paths: value: action: revoke responses: - '500': *103 + '500': *109 '404': *6 - '204': *175 + '204': *181 '403': *29 '422': *15 x-github: @@ -35255,7 +35592,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: - - *63 + - *67 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -35265,7 +35602,7 @@ paths: - *17 - *19 responses: - '500': *103 + '500': *109 '404': *6 '403': *29 '200': @@ -35274,11 +35611,11 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: *243 + default: *249 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35300,7 +35637,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *63 + - *67 - *17 - *19 responses: @@ -35318,7 +35655,7 @@ paths: type: integer configurations: type: array - items: &251 + items: &257 title: Organization private registry description: Private registry configuration for an organization type: object @@ -35398,7 +35735,7 @@ paths: updated_at: '2020-01-10T14:59:22Z' visibility: selected headers: - Link: *54 + Link: *58 '400': *14 '404': *6 x-github: @@ -35420,7 +35757,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *63 + - *67 requestBody: required: true content: @@ -35608,7 +35945,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &252 + org-private-registry-with-selected-visibility: &258 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -35649,7 +35986,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: - - *63 + - *67 responses: '200': description: Response @@ -35675,7 +36012,7 @@ paths: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -35697,16 +36034,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *63 - - *151 + - *67 + - *157 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *251 + schema: *257 examples: - default: *252 + default: *258 '404': *6 x-github: githubCloudOnly: false @@ -35727,8 +36064,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *63 - - *151 + - *67 + - *157 requestBody: required: true content: @@ -35832,8 +36169,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *63 - - *151 + - *67 + - *157 responses: '204': description: Response @@ -35856,15 +36193,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-organization parameters: - - *63 + - *67 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *40 - - *41 + - *45 + - *46 - *17 responses: '200': @@ -35873,7 +36210,7 @@ paths: application/json: schema: type: array - items: &253 + items: &259 title: Projects v2 Project description: A projects v2 project type: object @@ -35943,7 +36280,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &756 + properties: &767 id: type: number description: The unique identifier of the status update. @@ -35991,7 +36328,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &757 + required: &768 - id - node_id - created_at @@ -36016,7 +36353,7 @@ paths: - deleted_at - deleted_by examples: - default: &254 + default: &260 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -36099,7 +36436,7 @@ paths: updated_at: '2025-07-11T16:19:28Z' is_template: true headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -36119,24 +36456,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &255 + - &261 name: project_number description: The project's number. in: path required: true schema: type: integer - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: *253 + schema: *259 examples: - default: *254 + default: *260 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -36156,8 +36493,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - - *63 - - *255 + - *67 + - *261 requestBody: required: true description: Details of the draft item to create in the project. @@ -36191,7 +36528,7 @@ paths: description: Response content: application/json: - schema: &261 + schema: &267 title: Projects v2 Item description: An item belonging to a project type: object @@ -36204,8 +36541,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *82 - - &462 + - *86 + - &466 title: Pull Request Simple description: Pull Request Simple type: object @@ -36311,8 +36648,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *256 - required: *257 + properties: *262 + required: *263 nullable: true active_lock_reason: type: string @@ -36357,7 +36694,7 @@ paths: nullable: true requested_teams: type: array - items: *181 + items: *187 nullable: true head: type: object @@ -36366,7 +36703,7 @@ paths: type: string ref: type: string - repo: *66 + repo: *70 sha: type: string user: @@ -36389,7 +36726,7 @@ paths: type: string ref: type: string - repo: *66 + repo: *70 sha: type: string user: @@ -36408,7 +36745,7 @@ paths: _links: type: object properties: - comments: &258 + comments: &264 title: Link description: Hypermedia Link type: object @@ -36417,13 +36754,13 @@ paths: type: string required: - href - commits: *258 - statuses: *258 - html: *258 - issue: *258 - review_comments: *258 - review_comment: *258 - self: *258 + commits: *264 + statuses: *264 + html: *264 + issue: *264 + review_comments: *264 + review_comment: *264 + self: *264 required: - comments - commits @@ -36433,8 +36770,8 @@ paths: - review_comments - review_comment - self - author_association: *69 - auto_merge: &568 + author_association: *73 + auto_merge: &572 title: Auto merge description: The status of auto merging a pull request. type: object @@ -36536,7 +36873,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &260 + content_type: &266 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -36576,7 +36913,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &262 + draft_issue: &268 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -36650,11 +36987,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *255 - - *63 + - *261 + - *67 - *17 - - *40 - - *41 + - *45 + - *46 responses: '200': description: Response @@ -36662,7 +36999,7 @@ paths: application/json: schema: type: array - items: &259 + items: &265 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -36809,7 +37146,7 @@ paths: - updated_at - project_url examples: - default: &699 + default: &701 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -36920,7 +37257,7 @@ paths: created_at: '2022-06-20T16:45:00Z' updated_at: '2022-06-20T16:45:00Z' headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -36929,6 +37266,296 @@ 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: + - *261 + - *67 + 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: &702 + 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: &703 + 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: &704 + 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: &705 + 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: *265 + examples: + text_field: &706 + 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: &707 + 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: &708 + 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: &709 + 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: &710 + 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': *37 + '403': *29 + '401': *25 + '422': *15 + 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 @@ -36940,23 +37567,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *255 - - &700 + - *261 + - &711 name: field_id description: The unique identifier of the field. in: path required: true schema: type: integer - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: *259 + schema: *265 examples: - default: &701 + default: &712 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -36965,21 +37592,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: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -37000,8 +37639,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *255 - - *63 + - *261 + - *67 - 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. @@ -37023,8 +37662,8 @@ paths: maxItems: 50 items: type: string - - *40 - - *41 + - *45 + - *46 - *17 responses: '200': @@ -37033,7 +37672,7 @@ paths: application/json: schema: type: array - items: &263 + items: &269 title: Projects v2 Item description: An item belonging to a project type: object @@ -37049,7 +37688,7 @@ paths: format: uri example: https://api.github.com/users/monalisa/2/projectsV2/3 description: The API URL of the project that contains this item. - content_type: *260 + content_type: *266 content: type: object additionalProperties: true @@ -37092,7 +37731,7 @@ paths: - updated_at - archived_at examples: - default: &264 + default: &270 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -37768,7 +38407,7 @@ paths: type: sub_issues_progress value: headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -37788,8 +38427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - - *63 - - *255 + - *67 + - *261 requestBody: required: true description: Details of the item to add to the project. @@ -37826,10 +38465,10 @@ paths: description: Response content: application/json: - schema: *261 + schema: *267 examples: - issue: *262 - pull_request: *262 + issue: *268 + pull_request: *268 '304': *37 '403': *29 '401': *25 @@ -37849,9 +38488,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *255 - - *63 - - &265 + - *261 + - *67 + - &271 name: item_id description: The unique identifier of the project item. in: path @@ -37877,11 +38516,11 @@ paths: description: Response content: application/json: - schema: *263 + schema: *269 examples: - default: *264 + default: *270 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -37900,9 +38539,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *255 - - *63 - - *265 + - *261 + - *67 + - *271 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -37972,13 +38611,13 @@ paths: description: Response content: application/json: - schema: *263 + schema: *269 examples: - text_field: *264 - number_field: *264 - date_field: *264 - single_select_field: *264 - iteration_field: *264 + text_field: *270 + number_field: *270 + date_field: *270 + single_select_field: *270 + iteration_field: *270 '401': *25 '403': *29 '404': *6 @@ -37998,9 +38637,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *255 - - *63 - - *265 + - *261 + - *67 + - *271 responses: '204': description: Response @@ -38024,7 +38663,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Response @@ -38032,7 +38671,7 @@ paths: application/json: schema: type: array - items: &266 + items: &272 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -38096,7 +38735,7 @@ paths: - property_name - value_type examples: - default: &267 + default: &273 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -38144,7 +38783,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *63 + - *67 requestBody: required: true content: @@ -38155,7 +38794,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *266 + items: *272 minItems: 1 maxItems: 100 required: @@ -38185,9 +38824,9 @@ paths: application/json: schema: type: array - items: *266 + items: *272 examples: - default: *267 + default: *273 '403': *29 '404': *6 x-github: @@ -38208,8 +38847,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *63 - - &268 + - *67 + - &274 name: custom_property_name description: The custom property name in: path @@ -38221,9 +38860,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *272 examples: - default: &269 + default: &275 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -38257,8 +38896,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: - - *63 - - *268 + - *67 + - *274 requestBody: required: true content: @@ -38325,9 +38964,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *272 examples: - default: *269 + default: *275 '403': *29 '404': *6 x-github: @@ -38350,10 +38989,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *63 - - *268 + - *67 + - *274 responses: - '204': *175 + '204': *181 '403': *29 '404': *6 x-github: @@ -38374,7 +39013,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *63 + - *67 - *17 - *19 - name: repository_query @@ -38412,7 +39051,7 @@ paths: example: octocat/Hello-World properties: type: array - items: *102 + items: *108 description: List of custom property names and associated values required: - repository_id @@ -38433,7 +39072,7 @@ paths: - property_name: team value: octocat headers: - Link: *54 + Link: *58 '403': *29 '404': *6 x-github: @@ -38461,7 +39100,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: - - *63 + - *67 requestBody: required: true content: @@ -38481,7 +39120,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *102 + items: *108 required: - repository_names - properties @@ -38522,7 +39161,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *63 + - *67 - *17 - *19 responses: @@ -38534,9 +39173,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38553,8 +39192,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: + - *67 - *63 - - *59 responses: '204': description: Response if user is a public member @@ -38578,8 +39217,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: + - *67 - *63 - - *59 responses: '204': description: Response @@ -38600,8 +39239,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: + - *67 - *63 - - *59 responses: '204': description: Response @@ -38625,7 +39264,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *63 + - *67 - name: type description: Specifies the types of repositories you want returned. in: query @@ -38671,11 +39310,11 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: *243 + default: *249 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38694,7 +39333,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *63 + - *67 requestBody: required: true content: @@ -38875,7 +39514,7 @@ paths: description: Response content: application/json: - schema: &333 + schema: &335 title: Full Repository description: Full Repository type: object @@ -39152,8 +39791,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *270 - required: *271 + properties: *276 + required: *277 nullable: true temp_clone_token: type: string @@ -39240,8 +39879,8 @@ paths: title: License Simple description: License Simple type: object - properties: *83 - required: *84 + properties: *87 + required: *88 nullable: true organization: title: Simple User @@ -39250,8 +39889,8 @@ paths: properties: *20 required: *21 nullable: true - parent: *66 - source: *66 + parent: *70 + source: *70 forks: type: integer master_branch: @@ -39268,7 +39907,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &467 + properties: &471 url: type: string format: uri @@ -39284,12 +39923,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &468 + required: &472 - url - key - name - html_url - security_and_analysis: *272 + security_and_analysis: *278 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -39373,7 +40012,7 @@ paths: - network_count - subscribers_count examples: - default: &335 + default: &337 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -39891,10 +40530,10 @@ paths: category: orgs subcategory: rules parameters: - - *63 + - *67 - *17 - *19 - - &591 + - &594 name: targets description: | A comma-separated list of rule targets to filter by. @@ -39912,7 +40551,7 @@ paths: application/json: schema: type: array - items: &298 + items: &305 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -39947,7 +40586,7 @@ paths: source: type: string description: The name of the source - enforcement: &275 + enforcement: &281 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -39960,7 +40599,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &276 + items: &282 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -40030,7 +40669,7 @@ paths: conditions: nullable: true anyOf: - - &273 + - &279 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -40054,7 +40693,7 @@ paths: match. items: type: string - - &277 + - &283 title: Organization ruleset conditions type: object description: |- @@ -40068,7 +40707,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *273 + - *279 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -40102,7 +40741,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *273 + - *279 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -40124,7 +40763,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *273 + - *279 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -40137,7 +40776,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &274 + items: &280 title: Repository ruleset property targeting definition type: object @@ -40170,17 +40809,17 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *274 + items: *280 required: - repository_property rules: type: array - items: &592 + items: &595 title: Repository Rule type: object description: A repository rule. oneOf: - - &278 + - &284 title: creation description: Only allow users with bypass permission to create matching refs. @@ -40192,7 +40831,7 @@ paths: type: string enum: - creation - - &279 + - &285 title: update description: Only allow users with bypass permission to update matching refs. @@ -40213,7 +40852,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &280 + - &286 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -40225,7 +40864,7 @@ paths: type: string enum: - deletion - - &281 + - &287 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -40237,7 +40876,7 @@ paths: type: string enum: - required_linear_history - - &589 + - &593 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -40315,7 +40954,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &282 + - &288 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -40339,7 +40978,7 @@ paths: type: string required: - required_deployment_environments - - &283 + - &289 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -40351,7 +40990,7 @@ paths: type: string enum: - required_signatures - - &284 + - &290 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -40462,7 +41101,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &285 + - &291 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -40510,7 +41149,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &286 + - &292 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -40522,7 +41161,7 @@ paths: type: string enum: - non_fast_forward - - &287 + - &293 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -40558,7 +41197,7 @@ paths: required: - operator - pattern - - &288 + - &294 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -40594,7 +41233,7 @@ paths: required: - operator - pattern - - &289 + - &295 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -40630,7 +41269,7 @@ paths: required: - operator - pattern - - &290 + - &296 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -40666,7 +41305,7 @@ paths: required: - operator - pattern - - &291 + - &297 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -40702,7 +41341,7 @@ paths: required: - operator - pattern - - &292 + - &298 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -40727,7 +41366,7 @@ paths: type: string required: - restricted_file_paths - - &293 + - &299 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -40751,7 +41390,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &294 + - &300 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -40774,7 +41413,7 @@ paths: type: string required: - restricted_file_extensions - - &295 + - &301 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -40799,7 +41438,7 @@ paths: maximum: 100 required: - max_file_size - - &296 + - &302 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -40849,7 +41488,7 @@ paths: - repository_id required: - workflows - - &297 + - &303 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -40910,7 +41549,7 @@ paths: - tool required: - code_scanning_tools - - &590 + - &304 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -40971,7 +41610,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *103 + '500': *109 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -40987,7 +41626,7 @@ paths: category: orgs subcategory: rules parameters: - - *63 + - *67 requestBody: description: Request body required: true @@ -41008,26 +41647,20 @@ paths: - push - repository default: branch - enforcement: *275 + enforcement: *281 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *276 - conditions: *277 + items: *282 + conditions: *283 rules: type: array description: An array of rules within the ruleset. - items: &300 + items: &307 title: Repository Rule type: object description: A repository rule. oneOf: - - *278 - - *279 - - *280 - - *281 - - *282 - - *283 - *284 - *285 - *286 @@ -41042,6 +41675,13 @@ paths: - *295 - *296 - *297 + - *298 + - *299 + - *300 + - *301 + - *302 + - *303 + - *304 required: - name - enforcement @@ -41079,9 +41719,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: &299 + default: &306 value: id: 21 name: super cool ruleset @@ -41121,7 +41761,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *103 + '500': *109 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -41135,8 +41775,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *63 - - &593 + - *67 + - &596 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 @@ -41151,7 +41791,7 @@ paths: in: query schema: type: string - - &594 + - &597 name: time_period description: |- The time period to filter by. @@ -41167,14 +41807,14 @@ paths: - week - month default: day - - &595 + - &598 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &596 + - &599 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -41194,7 +41834,7 @@ paths: description: Response content: application/json: - schema: &597 + schema: &600 title: Rule Suites description: Response type: array @@ -41249,7 +41889,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &598 + default: &601 value: - id: 21 actor_id: 12 @@ -41273,7 +41913,7 @@ paths: result: pass evaluation_result: fail '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41292,8 +41932,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *63 - - &599 + - *67 + - &602 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -41309,7 +41949,7 @@ paths: description: Response content: application/json: - schema: &600 + schema: &603 title: Rule Suite description: Response type: object @@ -41408,7 +42048,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &601 + default: &604 value: id: 21 actor_id: 12 @@ -41443,7 +42083,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41469,7 +42109,7 @@ paths: category: orgs subcategory: rules parameters: - - *63 + - *67 - name: ruleset_id description: The ID of the ruleset. in: path @@ -41481,11 +42121,11 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 '404': *6 - '500': *103 + '500': *109 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -41501,7 +42141,7 @@ paths: category: orgs subcategory: rules parameters: - - *63 + - *67 - name: ruleset_id description: The ID of the ruleset. in: path @@ -41527,16 +42167,16 @@ paths: - tag - push - repository - enforcement: *275 + enforcement: *281 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *276 - conditions: *277 + items: *282 + conditions: *283 rules: description: An array of rules within the ruleset. type: array - items: *300 + items: *307 examples: default: value: @@ -41571,11 +42211,11 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 '404': *6 - '500': *103 + '500': *109 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -41591,7 +42231,7 @@ paths: category: orgs subcategory: rules parameters: - - *63 + - *67 - name: ruleset_id description: The ID of the ruleset. in: path @@ -41602,7 +42242,7 @@ paths: '204': description: Response '404': *6 - '500': *103 + '500': *109 "/orgs/{org}/rulesets/{ruleset_id}/history": get: summary: Get organization ruleset history @@ -41614,7 +42254,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history parameters: - - *63 + - *67 - *17 - *19 - name: ruleset_id @@ -41630,7 +42270,7 @@ paths: application/json: schema: type: array - items: &301 + items: &308 title: Ruleset version type: object description: The historical version of a ruleset @@ -41654,7 +42294,7 @@ paths: type: string format: date-time examples: - default: &603 + default: &606 value: - version_id: 3 actor: @@ -41672,7 +42312,7 @@ paths: type: User updated_at: '2024-08-23T16:29:47Z' '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41689,7 +42329,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version parameters: - - *63 + - *67 - name: ruleset_id description: The ID of the ruleset. in: path @@ -41707,9 +42347,9 @@ paths: description: Response content: application/json: - schema: &604 + schema: &607 allOf: - - *301 + - *308 - type: object required: - state @@ -41756,7 +42396,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41778,8 +42418,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *63 - - &605 + - *67 + - &608 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -41790,7 +42430,7 @@ paths: enum: - open - resolved - - &606 + - &609 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -41800,7 +42440,7 @@ paths: required: false schema: type: string - - &607 + - &610 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -41809,7 +42449,26 @@ paths: required: false schema: type: string - - &608 + - &611 + 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 + - &612 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. @@ -41821,10 +42480,10 @@ paths: - created - updated default: created - - *48 + - *52 - *19 - *17 - - &609 + - &613 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 @@ -41834,7 +42493,7 @@ paths: required: false schema: type: string - - &610 + - &614 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 @@ -41844,7 +42503,7 @@ paths: required: false schema: type: string - - &611 + - &615 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -41853,7 +42512,7 @@ paths: required: false schema: type: string - - &612 + - &616 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -41862,7 +42521,7 @@ paths: schema: type: boolean default: false - - &613 + - &617 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -41871,7 +42530,7 @@ paths: schema: type: boolean default: false - - &614 + - &618 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -41890,8 +42549,8 @@ paths: items: type: object properties: - number: *161 - created_at: *162 + number: *167 + created_at: *168 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -41899,21 +42558,21 @@ paths: format: date-time readOnly: true nullable: true - url: *164 - html_url: *165 + url: *170 + html_url: *171 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &615 + state: &619 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: &616 + resolution: &620 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -41947,7 +42606,7 @@ paths: secret: type: string description: The secret that was detected. - repository: *53 + repository: *57 push_protection_bypassed: type: boolean description: Whether push protection was bypassed for the detected @@ -42020,8 +42679,8 @@ paths: pull request. ' - oneOf: &617 - - &619 + oneOf: &621 + - &623 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -42073,7 +42732,7 @@ paths: - blob_url - commit_sha - commit_url - - &620 + - &624 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. @@ -42128,7 +42787,7 @@ paths: - page_url - commit_sha - commit_url - - &621 + - &625 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -42142,7 +42801,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &622 + - &626 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -42156,7 +42815,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &623 + - &627 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -42170,7 +42829,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &624 + - &628 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -42184,7 +42843,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &625 + - &629 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -42198,7 +42857,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &626 + - &630 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -42212,7 +42871,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &627 + - &631 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. @@ -42226,7 +42885,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &628 + - &632 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. @@ -42240,7 +42899,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &629 + - &633 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. @@ -42254,7 +42913,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &630 + - &634 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. @@ -42268,7 +42927,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &631 + - &635 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. @@ -42471,9 +43130,9 @@ paths: type: User site_admin: false headers: - Link: *54 + Link: *58 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42498,7 +43157,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *63 + - *67 responses: '200': description: Response @@ -42510,7 +43169,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &303 + pattern_config_version: &310 type: string description: The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate @@ -42519,7 +43178,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &302 + items: &309 type: object properties: token_type: @@ -42585,7 +43244,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *302 + items: *309 examples: default: value: @@ -42634,7 +43293,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *63 + - *67 requestBody: required: true content: @@ -42642,7 +43301,7 @@ paths: schema: type: object properties: - pattern_config_version: *303 + pattern_config_version: *310 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -42668,7 +43327,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *303 + custom_pattern_version: *310 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -42704,7 +43363,7 @@ paths: '400': *14 '403': *29 '404': *6 - '409': *47 + '409': *51 '422': *15 "/orgs/{org}/security-advisories": get: @@ -42722,8 +43381,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *63 - - *48 + - *67 + - *52 - name: sort description: The property to sort the results by. in: query @@ -42735,8 +43394,8 @@ paths: - updated - published default: created - - *40 - - *41 + - *45 + - *46 - 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)." @@ -42766,7 +43425,7 @@ paths: application/json: schema: type: array - items: &635 + items: &639 description: A repository security advisory. type: object properties: @@ -42953,7 +43612,7 @@ paths: required: - vector_string - score - cvss_severities: *50 + cvss_severities: *54 cwes: type: array nullable: true @@ -42986,7 +43645,7 @@ paths: login: type: string description: The username of the user credited. - type: *304 + type: *311 credits_detailed: type: array nullable: true @@ -42996,7 +43655,7 @@ paths: type: object properties: user: *4 - type: *304 + type: *311 state: type: string description: The state of the user's acceptance of the @@ -43020,14 +43679,14 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *181 + items: *187 private_fork: readOnly: true nullable: true description: A temporary private fork of the advisory's repository for collaborating on a fix. allOf: - - *53 + - *57 required: - ghsa_id - cve_id @@ -43057,7 +43716,7 @@ paths: - private_fork additionalProperties: false examples: - default: &636 + default: &640 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -43436,7 +44095,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *63 + - *67 responses: '200': description: Response @@ -43444,9 +44103,9 @@ paths: application/json: schema: type: array - items: *305 + items: *312 examples: - default: *236 + default: *242 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43469,8 +44128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *63 - - *64 + - *67 + - *68 responses: '204': description: Response @@ -43495,8 +44154,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *63 - - *64 + - *67 + - *68 responses: '204': description: Response @@ -43523,7 +44182,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - - *63 + - *67 responses: '200': description: Immutable releases settings response @@ -43572,7 +44231,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization parameters: - - *63 + - *67 responses: '204': description: Response @@ -43629,7 +44288,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - - *63 + - *67 - *19 - *17 responses: @@ -43647,9 +44306,9 @@ paths: type: integer repositories: type: array - items: *143 + items: *149 examples: - default: *155 + default: *161 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43668,7 +44327,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement parameters: - - *63 + - *67 requestBody: required: true content: @@ -43717,8 +44376,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: - - *63 - - *132 + - *67 + - *138 responses: '204': description: Response @@ -43740,8 +44399,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: - - *63 - - *132 + - *67 + - *138 responses: '204': description: Response @@ -43764,7 +44423,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *63 + - *67 - *17 - *19 responses: @@ -43782,7 +44441,7 @@ paths: type: integer network_configurations: type: array - items: &306 + items: &313 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -43841,7 +44500,7 @@ paths: - 6789ABDCEF12345 created_on: '2023-04-26T15:23:37Z' headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43860,7 +44519,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: - - *63 + - *67 requestBody: required: true content: @@ -43902,9 +44561,9 @@ paths: description: Response content: application/json: - schema: *306 + schema: *313 examples: - default: &307 + default: &314 value: id: 123456789ABCDEF name: My network configuration @@ -43932,8 +44591,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: - - *63 - - &308 + - *67 + - &315 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -43945,11 +44604,11 @@ paths: description: Response content: application/json: - schema: *306 + schema: *313 examples: - default: *307 + default: *314 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43968,8 +44627,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: - - *63 - - *308 + - *67 + - *315 requestBody: required: true content: @@ -44008,9 +44667,9 @@ paths: description: Response content: application/json: - schema: *306 + schema: *313 examples: - default: *307 + default: *314 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44029,8 +44688,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: - - *63 - - *308 + - *67 + - *315 responses: '204': description: Response @@ -44053,7 +44712,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: - - *63 + - *67 - name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -44107,7 +44766,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: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44137,8 +44796,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *63 - - *64 + - *67 + - *68 - 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`). @@ -44170,13 +44829,13 @@ paths: application/json: schema: type: array - items: *309 + items: *316 examples: - default: *310 - '500': *103 + default: *317 + '500': *109 '403': *29 '404': *6 - '422': *311 + '422': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44194,7 +44853,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *63 + - *67 - *17 - *19 responses: @@ -44204,11 +44863,11 @@ paths: application/json: schema: type: array - items: *181 + items: *187 examples: - default: *236 + default: *242 headers: - Link: *54 + Link: *58 '403': *29 x-github: githubCloudOnly: false @@ -44228,7 +44887,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *63 + - *67 requestBody: required: true content: @@ -44300,7 +44959,7 @@ paths: description: Response content: application/json: - schema: &312 + schema: &319 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -44363,8 +45022,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *234 - required: *235 + properties: *240 + required: *241 nullable: true members_count: type: integer @@ -44627,7 +45286,7 @@ paths: - repos_count - organization examples: - default: &313 + default: &320 value: id: 1 node_id: MDQ6VGVhbTE= @@ -44697,16 +45356,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *63 - - *64 + - *67 + - *68 responses: '200': description: Response content: application/json: - schema: *312 + schema: *319 examples: - default: *313 + default: *320 '404': *6 x-github: githubCloudOnly: false @@ -44727,8 +45386,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *63 - - *64 + - *67 + - *68 requestBody: required: false content: @@ -44790,16 +45449,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *312 + schema: *319 examples: - default: *313 + default: *320 '201': description: Response content: application/json: - schema: *312 + schema: *319 examples: - default: *313 + default: *320 '404': *6 '422': *15 '403': *29 @@ -44824,8 +45483,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *63 - - *64 + - *67 + - *68 responses: '204': description: Response @@ -44851,9 +45510,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - - *63 - - *64 - - *48 + - *67 + - *68 + - *52 - *17 - *19 - name: pinned @@ -44869,7 +45528,7 @@ paths: application/json: schema: type: array - items: &314 + items: &321 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -44948,7 +45607,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *70 + reactions: *74 required: - author - body @@ -44968,7 +45627,7 @@ paths: - updated_at - url examples: - default: &653 + default: &657 value: - author: login: octocat @@ -45018,7 +45677,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45042,8 +45701,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - - *63 - - *64 + - *67 + - *68 requestBody: required: true content: @@ -45077,9 +45736,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: &315 + default: &322 value: author: login: octocat @@ -45151,9 +45810,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - - *63 - - *64 - - &316 + - *67 + - *68 + - &323 name: discussion_number description: The number that identifies the discussion. in: path @@ -45165,9 +45824,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45189,9 +45848,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - - *63 - - *64 - - *316 + - *67 + - *68 + - *323 requestBody: required: false content: @@ -45214,9 +45873,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: &654 + default: &658 value: author: login: octocat @@ -45286,9 +45945,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - - *63 - - *64 - - *316 + - *67 + - *68 + - *323 responses: '204': description: Response @@ -45314,10 +45973,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - - *63 - - *64 - - *316 - - *48 + - *67 + - *68 + - *323 + - *52 - *17 - *19 responses: @@ -45327,7 +45986,7 @@ paths: application/json: schema: type: array - items: &317 + items: &324 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -45384,7 +46043,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *70 + reactions: *74 required: - author - body @@ -45399,7 +46058,7 @@ paths: - updated_at - url examples: - default: &655 + default: &659 value: - author: login: octocat @@ -45443,7 +46102,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45467,9 +46126,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *63 - - *64 - - *316 + - *67 + - *68 + - *323 requestBody: required: true content: @@ -45491,9 +46150,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *324 examples: - default: &318 + default: &325 value: author: login: octocat @@ -45559,10 +46218,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *63 - - *64 - - *316 - - &319 + - *67 + - *68 + - *323 + - &326 name: comment_number description: The number that identifies the comment. in: path @@ -45574,9 +46233,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *324 examples: - default: *318 + default: *325 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45598,10 +46257,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *63 - - *64 - - *316 - - *319 + - *67 + - *68 + - *323 + - *326 requestBody: required: true content: @@ -45623,9 +46282,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *324 examples: - default: &656 + default: &660 value: author: login: octocat @@ -45689,10 +46348,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *63 - - *64 - - *316 - - *319 + - *67 + - *68 + - *323 + - *326 responses: '204': description: Response @@ -45718,10 +46377,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *63 - - *64 - - *316 - - *319 + - *67 + - *68 + - *323 + - *326 - 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. @@ -45747,7 +46406,7 @@ paths: application/json: schema: type: array - items: &320 + items: &327 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -45790,7 +46449,7 @@ paths: - content - created_at examples: - default: &322 + default: &329 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -45816,7 +46475,7 @@ paths: content: heart created_at: '2016-05-20T20:09:31Z' headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45840,10 +46499,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *63 - - *64 - - *316 - - *319 + - *67 + - *68 + - *323 + - *326 requestBody: required: true content: @@ -45876,9 +46535,9 @@ paths: team discussion comment content: application/json: - schema: *320 + schema: *327 examples: - default: &321 + default: &328 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -45907,9 +46566,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45932,11 +46591,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *63 - - *64 - - *316 - - *319 - - &323 + - *67 + - *68 + - *323 + - *326 + - &330 name: reaction_id description: The unique identifier of the reaction. in: path @@ -45968,9 +46627,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *63 - - *64 - - *316 + - *67 + - *68 + - *323 - 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. @@ -45996,11 +46655,11 @@ paths: application/json: schema: type: array - items: *320 + items: *327 examples: - default: *322 + default: *329 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46024,9 +46683,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *63 - - *64 - - *316 + - *67 + - *68 + - *323 requestBody: required: true content: @@ -46058,16 +46717,16 @@ paths: description: Response content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '201': description: Response content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -46090,10 +46749,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *63 - - *64 - - *316 + - *67 + - *68 - *323 + - *330 responses: '204': description: Response @@ -46117,8 +46776,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *63 - - *64 + - *67 + - *68 - *17 - *19 responses: @@ -46128,11 +46787,11 @@ paths: application/json: schema: type: array - items: *216 + items: *222 examples: - default: *217 + default: *223 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46152,8 +46811,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *63 - - *64 + - *67 + - *68 - name: role description: Filters members returned by their role in the team. in: query @@ -46176,9 +46835,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46206,15 +46865,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: + - *67 + - *68 - *63 - - *64 - - *59 responses: '200': description: Response content: application/json: - schema: &324 + schema: &331 title: Team Membership description: Team Membership type: object @@ -46241,7 +46900,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &657 + response-if-user-is-a-team-maintainer: &661 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -46277,9 +46936,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: + - *67 + - *68 - *63 - - *64 - - *59 requestBody: required: false content: @@ -46304,9 +46963,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *331 examples: - response-if-users-membership-with-team-is-now-pending: &658 + response-if-users-membership-with-team-is-now-pending: &662 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -46341,9 +47000,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: + - *67 + - *68 - *63 - - *64 - - *59 responses: '204': description: Response @@ -46354,322 +47013,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: - - *63 - - *64 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &325 - 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 - nullable: true - 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: &659 - 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: *54 - 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: - - *63 - - *64 - - &326 - 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: *325 - examples: - default: &660 - 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: - - *63 - - *64 - - *326 - 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 - nullable: true - 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: - - *63 - - *64 - - *326 - 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 @@ -46685,8 +47028,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *63 - - *64 + - *67 + - *68 - *17 - *19 responses: @@ -46696,11 +47039,11 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: *243 + default: *249 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46727,16 +47070,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *63 - - *64 - - *327 - - *328 + - *67 + - *68 + - *332 + - *333 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &661 + schema: &663 title: Team Repository description: A team's access to a repository. type: object @@ -46759,8 +47102,8 @@ paths: title: License Simple description: License Simple type: object - properties: *83 - required: *84 + properties: *87 + required: *88 nullable: true forks: type: integer @@ -47305,10 +47648,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *63 - - *64 - - *327 - - *328 + - *67 + - *68 + - *332 + - *333 requestBody: required: false content: @@ -47353,10 +47696,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *63 - - *64 - - *327 - - *328 + - *67 + - *68 + - *332 + - *333 responses: '204': description: Response @@ -47380,8 +47723,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *63 - - *64 + - *67 + - *68 - *17 - *19 responses: @@ -47391,9 +47734,9 @@ paths: application/json: schema: type: array - items: *181 + items: *187 examples: - response-if-child-teams-exist: &662 + response-if-child-teams-exist: &664 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -47421,7 +47764,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47446,7 +47789,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *63 + - *67 - name: security_product in: path description: The security feature to enable or disable. @@ -47506,455 +47849,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: - - &329 - 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: &330 - title: Project Column - description: Project columns contain cards of work. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - cards_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - example: 42 - type: integer - node_id: - type: string - example: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - example: Remaining tasks - type: string - created_at: - type: string - format: date-time - example: '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - example: '2016-09-05T14:22:28Z' - required: - - id - - node_id - - url - - project_url - - cards_url - - name - - created_at - - updated_at - examples: - default: &331 - 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': *37 - '403': *29 - '404': *6 - '401': *25 - 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: - - *329 - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project column - example: Remaining tasks - type: string - required: - - name - type: object - examples: - default: - summary: Rename the project column - value: - name: To Do - responses: - '200': - description: Response - content: - application/json: - schema: *330 - examples: - default: *331 - '304': *37 - '403': *29 - '401': *25 - 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: - - *329 - responses: - '204': - description: Response - '304': *37 - '403': *29 - '401': *25 - 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: - - *329 - 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.' - example: last - type: string - pattern: "^(?:first|last|after:\\d+)$" - 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': *37 - '403': *29 - '422': *7 - '401': *25 - 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: - - *326 - - 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: *58 - headers: - Link: *54 - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - 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: - - *326 - - *59 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - example: write - type: string - nullable: true - examples: - default: - summary: Applying write permissions for the new collaborator - value: - permission: write - responses: - '204': - description: Response - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - 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: - - *326 - - *59 - responses: - '204': - description: Response - '304': *37 - '404': *6 - '403': *29 - '422': *15 - '401': *25 - 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: - - *326 - - *59 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Project Collaborator Permission - description: Project Collaborator Permission - type: object - properties: - permission: - type: string - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - 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': *37 - '403': *29 - '401': *25 - 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 @@ -47996,7 +47890,7 @@ paths: resources: type: object properties: - core: &332 + core: &334 title: Rate Limit type: object properties: @@ -48013,21 +47907,21 @@ paths: - remaining - reset - used - graphql: *332 - search: *332 - code_search: *332 - source_import: *332 - integration_manifest: *332 - code_scanning_upload: *332 - actions_runner_registration: *332 - scim: *332 - dependency_snapshots: *332 - dependency_sbom: *332 - code_scanning_autofix: *332 + graphql: *334 + search: *334 + code_search: *334 + source_import: *334 + integration_manifest: *334 + code_scanning_upload: *334 + actions_runner_registration: *334 + scim: *334 + dependency_snapshots: *334 + dependency_sbom: *334 + code_scanning_autofix: *334 required: - core - search - rate: *332 + rate: *334 required: - rate - resources @@ -48132,14 +48026,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *333 + schema: *335 examples: default-response: summary: Default response @@ -48640,7 +48534,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *334 + '301': *336 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48658,8 +48552,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: false content: @@ -48906,10 +48800,10 @@ paths: description: Response content: application/json: - schema: *333 + schema: *335 examples: - default: *335 - '307': &336 + default: *337 + '307': &338 description: Temporary Redirect content: application/json: @@ -48938,8 +48832,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -48961,9 +48855,9 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *336 + '307': *338 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48985,11 +48879,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 - - &367 + - &371 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -49012,7 +48906,7 @@ paths: type: integer artifacts: type: array - items: &337 + items: &339 title: Artifact description: An artifact type: object @@ -49090,7 +48984,7 @@ paths: - expires_at - updated_at examples: - default: &368 + default: &372 value: total_count: 2 artifacts: @@ -49129,7 +49023,7 @@ paths: head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49151,9 +49045,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *327 - - *328 - - &338 + - *332 + - *333 + - &340 name: artifact_id description: The unique identifier of the artifact. in: path @@ -49165,7 +49059,7 @@ paths: description: Response content: application/json: - schema: *337 + schema: *339 examples: default: value: @@ -49203,9 +49097,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *327 - - *328 - - *338 + - *332 + - *333 + - *340 responses: '204': description: Response @@ -49229,9 +49123,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *327 - - *328 - - *338 + - *332 + - *333 + - *340 - name: archive_format in: path required: true @@ -49245,7 +49139,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': &523 + '410': &527 description: Gone content: application/json: @@ -49255,6 +49149,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: + - *332 + - *333 + responses: + '200': + description: Response + content: + application/json: + schema: &341 + 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 + example: 14 + examples: + default: *42 + '403': *29 + '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: + - *332 + - *333 + requestBody: + required: true + content: + application/json: + schema: *341 + examples: + selected_actions: *42 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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: + - *332 + - *333 + responses: + '200': + description: Response + content: + application/json: + schema: &342 + 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 + example: 10 + examples: + default: *44 + '403': *29 + '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: + - *332 + - *333 + requestBody: + required: true + content: + application/json: + schema: *342 + examples: + selected_actions: *44 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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 @@ -49272,14 +49316,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *339 + schema: *343 examples: default: value: @@ -49305,11 +49349,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 - - &340 + - &344 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 @@ -49337,13 +49381,13 @@ paths: - last_accessed_at - size_in_bytes default: last_accessed_at - - *48 + - *52 responses: '200': description: Response content: application/json: - schema: &341 + schema: &345 title: Repository actions caches description: Repository actions caches type: object @@ -49385,7 +49429,7 @@ paths: - total_count - actions_caches examples: - default: &342 + default: &346 value: total_count: 1 actions_caches: @@ -49397,7 +49441,7 @@ paths: created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49417,23 +49461,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: - - *327 - - *328 + - *332 + - *333 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *340 + - *344 responses: '200': description: Response content: application/json: - schema: *341 + schema: *345 examples: - default: *342 + default: *346 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49453,8 +49497,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: - - *327 - - *328 + - *332 + - *333 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -49485,9 +49529,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *327 - - *328 - - &343 + - *332 + - *333 + - &347 name: job_id description: The unique identifier of the job. in: path @@ -49499,7 +49543,7 @@ paths: description: Response content: application/json: - schema: &371 + schema: &375 title: Job description: Information of a job execution in a workflow run type: object @@ -49806,9 +49850,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *327 - - *328 - - *343 + - *332 + - *333 + - *347 responses: '302': description: Response @@ -49836,9 +49880,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *327 - - *328 - - *343 + - *332 + - *333 + - *347 requestBody: required: false content: @@ -49859,7 +49903,7 @@ paths: description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -49883,8 +49927,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: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Status response @@ -49934,8 +49978,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: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -49969,7 +50013,7 @@ paths: description: Empty response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -49998,8 +50042,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -50017,7 +50061,7 @@ paths: type: integer secrets: type: array - items: &373 + items: &377 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -50037,7 +50081,7 @@ paths: - created_at - updated_at examples: - default: &374 + default: &378 value: total_count: 2 secrets: @@ -50048,7 +50092,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50070,9 +50114,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *327 - - *328 - - *344 + - *332 + - *333 + - *348 - *19 responses: '200': @@ -50089,7 +50133,7 @@ paths: type: integer variables: type: array - items: &377 + items: &381 title: Actions Variable type: object properties: @@ -50119,7 +50163,7 @@ paths: - created_at - updated_at examples: - default: &378 + default: &382 value: total_count: 2 variables: @@ -50132,7 +50176,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50152,8 +50196,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -50162,12 +50206,12 @@ paths: schema: type: object properties: - enabled: &346 + enabled: &350 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *128 - selected_actions_url: *345 - sha_pinning_required: *129 + allowed_actions: *134 + selected_actions_url: *349 + sha_pinning_required: *135 required: - enabled examples: @@ -50195,8 +50239,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -50207,9 +50251,9 @@ paths: schema: type: object properties: - enabled: *346 - allowed_actions: *128 - sha_pinning_required: *129 + enabled: *350 + allowed_actions: *134 + sha_pinning_required: *135 required: - enabled examples: @@ -50239,14 +50283,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: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: &347 + schema: &351 type: object properties: access_level: @@ -50263,7 +50307,7 @@ paths: required: - access_level examples: - default: &348 + default: &352 value: access_level: organization x-github: @@ -50287,15 +50331,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: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: application/json: - schema: *347 + schema: *351 examples: - default: *348 + default: *352 responses: '204': description: Response @@ -50319,14 +50363,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *349 + schema: *353 examples: default: value: @@ -50350,8 +50394,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Empty response for successful settings update @@ -50361,7 +50405,7 @@ paths: required: true content: application/json: - schema: *350 + schema: *354 examples: default: summary: Set retention days @@ -50385,16 +50429,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *130 + schema: *136 examples: - default: *351 + default: *355 '404': *6 x-github: enabledForGitHubApps: true @@ -50413,8 +50457,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -50424,7 +50468,7 @@ paths: required: true content: application/json: - schema: *130 + schema: *136 examples: default: summary: Set approval policy to first time contributors @@ -50448,16 +50492,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: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *352 + schema: *356 examples: - default: *131 + default: *137 '403': *29 '404': *6 x-github: @@ -50477,15 +50521,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: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: application/json: - schema: *353 + schema: *357 examples: - default: *131 + default: *137 responses: '204': description: Empty response for successful settings update @@ -50509,16 +50553,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *133 + schema: *139 examples: - default: *134 + default: *140 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50537,8 +50581,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -50546,9 +50590,9 @@ paths: required: false content: application/json: - schema: *133 + schema: *139 examples: - selected_actions: *134 + selected_actions: *140 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50570,16 +50614,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *354 + schema: *358 examples: - default: *138 + default: *144 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50600,8 +50644,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Success response @@ -50612,9 +50656,9 @@ paths: required: true content: application/json: - schema: *355 + schema: *359 examples: - default: *138 + default: *144 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50641,8 +50685,8 @@ paths: in: query schema: type: string - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -50660,11 +50704,11 @@ paths: type: integer runners: type: array - items: *145 + items: *151 examples: - default: *146 + default: *152 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50686,8 +50730,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -50695,9 +50739,9 @@ paths: application/json: schema: type: array - items: *356 + items: *360 examples: - default: *357 + default: *361 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50719,8 +50763,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: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -50763,10 +50807,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *358 + '201': *362 '404': *6 '422': *7 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50794,16 +50838,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '201': description: Response content: application/json: - schema: *147 + schema: *153 examples: - default: *359 + default: *363 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50831,16 +50875,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '201': description: Response content: application/json: - schema: *147 + schema: *153 examples: - default: *360 + default: *364 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50862,17 +50906,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: - - *327 - - *328 - - *144 + - *332 + - *333 + - *150 responses: '200': description: Response content: application/json: - schema: *145 + schema: *151 examples: - default: *361 + default: *365 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50893,9 +50937,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: - - *327 - - *328 - - *144 + - *332 + - *333 + - *150 responses: '204': description: Response @@ -50921,11 +50965,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: - - *327 - - *328 - - *144 + - *332 + - *333 + - *150 responses: - '200': *149 + '200': *155 '404': *6 x-github: githubCloudOnly: false @@ -50947,9 +50991,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: - - *327 - - *328 - - *144 + - *332 + - *333 + - *150 requestBody: required: true content: @@ -50973,7 +51017,7 @@ paths: - gpu - accelerated responses: - '200': *149 + '200': *155 '404': *6 '422': *7 x-github: @@ -50997,9 +51041,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: - - *327 - - *328 - - *144 + - *332 + - *333 + - *150 requestBody: required: true content: @@ -51024,7 +51068,7 @@ paths: - gpu - accelerated responses: - '200': *149 + '200': *155 '404': *6 '422': *7 x-github: @@ -51048,11 +51092,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: - - *327 - - *328 - - *144 + - *332 + - *333 + - *150 responses: - '200': *362 + '200': *366 '404': *6 x-github: githubCloudOnly: false @@ -51079,12 +51123,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: - - *327 - - *328 - - *144 - - *363 + - *332 + - *333 + - *150 + - *367 responses: - '200': *149 + '200': *155 '404': *6 '422': *7 x-github: @@ -51110,9 +51154,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *327 - - *328 - - &381 + - *332 + - *333 + - &385 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. @@ -51120,7 +51164,7 @@ paths: required: false schema: type: string - - &382 + - &386 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -51128,7 +51172,7 @@ paths: required: false schema: type: string - - &383 + - &387 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -51137,7 +51181,7 @@ paths: required: false schema: type: string - - &384 + - &388 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 @@ -51164,7 +51208,7 @@ paths: - pending - *17 - *19 - - &385 + - &389 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)." @@ -51173,7 +51217,7 @@ paths: schema: type: string format: date-time - - &364 + - &368 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -51182,13 +51226,13 @@ paths: schema: type: boolean default: false - - &386 + - &390 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &387 + - &391 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -51211,7 +51255,7 @@ paths: type: integer workflow_runs: type: array - items: &365 + items: &369 title: Workflow Run description: An invocation of a workflow type: object @@ -51306,7 +51350,7 @@ paths: that triggered the run. type: array nullable: true - items: &406 + items: &410 title: Pull Request Minimal type: object properties: @@ -51425,7 +51469,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &410 + properties: &414 id: type: string description: SHA for the commit @@ -51476,7 +51520,7 @@ paths: - name - email nullable: true - required: &411 + required: &415 - id - tree_id - message @@ -51484,8 +51528,8 @@ paths: - author - committer nullable: true - repository: *143 - head_repository: *143 + repository: *149 + head_repository: *149 head_repository_id: type: integer example: 5 @@ -51523,7 +51567,7 @@ paths: - workflow_url - pull_requests examples: - default: &388 + default: &392 value: total_count: 1 workflow_runs: @@ -51737,7 +51781,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: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51759,24 +51803,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *327 - - *328 - - &366 + - *332 + - *333 + - &370 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *364 + - *368 responses: '200': description: Response content: application/json: - schema: *365 + schema: *369 examples: - default: &369 + default: &373 value: id: 30433642 name: Build @@ -52017,9 +52061,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 responses: '204': description: Response @@ -52042,9 +52086,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 responses: '200': description: Response @@ -52163,15 +52207,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: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 responses: '201': description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -52198,12 +52242,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 - *17 - *19 - - *367 + - *371 responses: '200': description: Response @@ -52219,11 +52263,11 @@ paths: type: integer artifacts: type: array - items: *337 + items: *339 examples: - default: *368 + default: *372 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52245,25 +52289,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *327 - - *328 - - *366 - - &370 + - *332 + - *333 + - *370 + - &374 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *364 + - *368 responses: '200': description: Response content: application/json: - schema: *365 + schema: *369 examples: - default: *369 + default: *373 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52286,10 +52330,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *327 - - *328 - - *366 + - *332 + - *333 - *370 + - *374 - *17 - *19 responses: @@ -52307,9 +52351,9 @@ paths: type: integer jobs: type: array - items: *371 + items: *375 examples: - default: &372 + default: &376 value: total_count: 1 jobs: @@ -52398,7 +52442,7 @@ paths: workflow_name: CI head_branch: main headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -52422,10 +52466,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *327 - - *328 - - *366 + - *332 + - *333 - *370 + - *374 responses: '302': description: Response @@ -52453,19 +52497,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 responses: '202': description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52488,9 +52532,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: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 requestBody: required: true content: @@ -52557,19 +52601,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 responses: '202': description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52592,9 +52636,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 - 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 @@ -52624,11 +52668,11 @@ paths: type: integer jobs: type: array - items: *371 + items: *375 examples: - default: *372 + default: *376 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52651,9 +52695,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 responses: '302': description: Response @@ -52680,14 +52724,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 responses: '204': description: Response '403': *29 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52709,9 +52753,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 responses: '200': description: Response @@ -52771,7 +52815,7 @@ paths: items: type: object properties: - type: &489 + type: &493 type: string description: The type of reviewer. enum: @@ -52781,7 +52825,7 @@ paths: reviewer: anyOf: - *4 - - *181 + - *187 required: - environment - wait_timer @@ -52856,9 +52900,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 requestBody: required: true content: @@ -52905,7 +52949,7 @@ paths: application/json: schema: type: array - items: &484 + items: &488 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -52993,8 +53037,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 required: - id - node_id @@ -53011,7 +53055,7 @@ paths: - created_at - updated_at examples: - default: &485 + default: &489 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -53067,9 +53111,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 requestBody: required: false content: @@ -53090,7 +53134,7 @@ paths: description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -53113,9 +53157,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 requestBody: required: false content: @@ -53136,7 +53180,7 @@ paths: description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -53168,9 +53212,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *327 - - *328 - - *366 + - *332 + - *333 + - *370 responses: '200': description: Response @@ -53307,8 +53351,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -53326,11 +53370,11 @@ paths: type: integer secrets: type: array - items: *373 + items: *377 examples: - default: *374 + default: *378 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53353,16 +53397,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *375 + schema: *379 examples: - default: *376 + default: *380 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53384,17 +53428,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *327 - - *328 - - *151 + - *332 + - *333 + - *157 responses: '200': description: Response content: application/json: - schema: *373 + schema: *377 examples: - default: &502 + default: &506 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -53420,9 +53464,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 - - *151 + - *332 + - *333 + - *157 requestBody: required: true content: @@ -53453,7 +53497,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -53479,9 +53523,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *327 - - *328 - - *151 + - *332 + - *333 + - *157 responses: '204': description: Response @@ -53506,9 +53550,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *327 - - *328 - - *344 + - *332 + - *333 + - *348 - *19 responses: '200': @@ -53525,11 +53569,11 @@ paths: type: integer variables: type: array - items: *377 + items: *381 examples: - default: *378 + default: *382 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53550,8 +53594,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -53578,7 +53622,7 @@ paths: description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -53603,17 +53647,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *327 - - *328 - - *154 + - *332 + - *333 + - *160 responses: '200': description: Response content: application/json: - schema: *377 + schema: *381 examples: - default: &503 + default: &507 value: name: USERNAME value: octocat @@ -53639,9 +53683,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *327 - - *328 - - *154 + - *332 + - *333 + - *160 requestBody: required: true content: @@ -53683,9 +53727,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *327 - - *328 - - *154 + - *332 + - *333 + - *160 responses: '204': description: Response @@ -53710,8 +53754,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -53729,7 +53773,7 @@ paths: type: integer workflows: type: array - items: &379 + items: &383 title: Workflow description: A GitHub Actions workflow type: object @@ -53813,7 +53857,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: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53836,9 +53880,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *327 - - *328 - - &380 + - *332 + - *333 + - &384 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -53853,7 +53897,7 @@ paths: description: Response content: application/json: - schema: *379 + schema: *383 examples: default: value: @@ -53886,9 +53930,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *327 - - *328 - - *380 + - *332 + - *333 + - *384 responses: '204': description: Response @@ -53913,9 +53957,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *327 - - *328 - - *380 + - *332 + - *333 + - *384 responses: '204': description: Response @@ -53966,9 +54010,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *327 - - *328 - - *380 + - *332 + - *333 + - *384 responses: '204': description: Response @@ -53995,19 +54039,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *327 - - *328 - - *380 - - *381 - - *382 - - *383 + - *332 + - *333 - *384 - - *17 - - *19 - *385 - - *364 - *386 - *387 + - *388 + - *17 + - *19 + - *389 + - *368 + - *390 + - *391 responses: '200': description: Response @@ -54023,11 +54067,11 @@ paths: type: integer workflow_runs: type: array - items: *365 + items: *369 examples: - default: *388 + default: *392 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54057,9 +54101,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *327 - - *328 - - *380 + - *332 + - *333 + - *384 responses: '200': description: Response @@ -54120,12 +54164,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *327 - - *328 - - *48 + - *332 + - *333 + - *52 - *17 - - *40 - - *41 + - *45 + - *46 - name: ref description: |- The Git reference for the activities you want to list. @@ -54266,7 +54310,7 @@ paths: type: User site_admin: false headers: - Link: *54 + Link: *58 '422': *7 x-github: githubCloudOnly: false @@ -54285,8 +54329,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -54298,9 +54342,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -54323,8 +54367,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *327 - - *328 + - *332 + - *333 - name: assignee in: path required: true @@ -54360,8 +54404,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -54473,11 +54517,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: - - *327 - - *328 + - *332 + - *333 - *17 - - *40 - - *41 + - *45 + - *46 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -54531,7 +54575,7 @@ paths: initiator: type: string examples: - default: *389 + default: *393 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54551,8 +54595,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -54560,7 +54604,7 @@ paths: application/json: schema: type: array - items: &390 + items: &394 title: Autolink reference description: An autolink reference. type: object @@ -54614,8 +54658,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -54654,9 +54698,9 @@ paths: description: response content: application/json: - schema: *390 + schema: *394 examples: - default: &391 + default: &395 value: id: 1 key_prefix: TICKET- @@ -54687,9 +54731,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *327 - - *328 - - &392 + - *332 + - *333 + - &396 name: autolink_id description: The unique identifier of the autolink. in: path @@ -54701,9 +54745,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *394 examples: - default: *391 + default: *395 '404': *6 x-github: githubCloudOnly: false @@ -54723,9 +54767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *327 - - *328 - - *392 + - *332 + - *333 + - *396 responses: '204': description: Response @@ -54749,8 +54793,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: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response if Dependabot is enabled @@ -54798,8 +54842,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -54820,8 +54864,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -54841,8 +54885,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *327 - - *328 + - *332 + - *333 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -54880,7 +54924,7 @@ paths: - url protected: type: boolean - protection: &394 + protection: &398 title: Branch Protection description: Branch Protection type: object @@ -54922,7 +54966,7 @@ paths: required: - contexts - checks - enforce_admins: &397 + enforce_admins: &401 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -54937,7 +54981,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &399 + required_pull_request_reviews: &403 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -54958,7 +55002,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *181 + items: *187 apps: description: The list of apps with review dismissal access. @@ -54987,7 +55031,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *181 + items: *187 apps: description: The list of apps allowed to bypass pull request requirements. @@ -55013,7 +55057,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &396 + restrictions: &400 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -55076,7 +55120,7 @@ paths: type: string teams: type: array - items: *181 + items: *187 apps: type: array items: @@ -55272,7 +55316,7 @@ paths: - linter protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -55290,9 +55334,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *327 - - *328 - - &395 + - *332 + - *333 + - &399 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). @@ -55306,14 +55350,14 @@ paths: description: Response content: application/json: - schema: &405 + schema: &409 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &458 + commit: &462 title: Commit description: Commit type: object @@ -55347,7 +55391,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &393 + properties: &397 name: type: string example: '"Chris Wanstrath"' @@ -55356,13 +55400,14 @@ paths: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true committer: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *393 + properties: *397 nullable: true message: type: string @@ -55383,7 +55428,7 @@ paths: required: - sha - url - verification: &509 + verification: &513 title: Verification type: object properties: @@ -55417,12 +55462,12 @@ paths: nullable: true oneOf: - *4 - - *152 + - *158 committer: nullable: true oneOf: - *4 - - *152 + - *158 parents: type: array items: @@ -55453,7 +55498,7 @@ paths: type: integer files: type: array - items: &471 + items: &475 title: Diff Entry description: Diff Entry type: object @@ -55537,7 +55582,7 @@ paths: - self protected: type: boolean - protection: *394 + protection: *398 protection_url: type: string format: uri @@ -55644,7 +55689,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *334 + '301': *336 '404': *6 x-github: githubCloudOnly: false @@ -55666,15 +55711,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response content: application/json: - schema: *394 + schema: *398 examples: default: value: @@ -55868,9 +55913,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: true content: @@ -56125,7 +56170,7 @@ paths: url: type: string format: uri - required_status_checks: &402 + required_status_checks: &406 title: Status Check Policy description: Status Check Policy type: object @@ -56201,7 +56246,7 @@ paths: items: *4 teams: type: array - items: *181 + items: *187 apps: type: array items: *5 @@ -56219,7 +56264,7 @@ paths: items: *4 teams: type: array - items: *181 + items: *187 apps: type: array items: *5 @@ -56277,7 +56322,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *396 + restrictions: *400 required_conversation_resolution: type: object properties: @@ -56389,9 +56434,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '204': description: Response @@ -56416,17 +56461,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response content: application/json: - schema: *397 + schema: *401 examples: - default: &398 + default: &402 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -56448,17 +56493,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response content: application/json: - schema: *397 + schema: *401 examples: - default: *398 + default: *402 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56477,9 +56522,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '204': description: Response @@ -56504,17 +56549,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response content: application/json: - schema: *399 + schema: *403 examples: - default: &400 + default: &404 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -56610,9 +56655,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: false content: @@ -56710,9 +56755,9 @@ paths: description: Response content: application/json: - schema: *399 + schema: *403 examples: - default: *400 + default: *404 '422': *15 x-github: githubCloudOnly: false @@ -56733,9 +56778,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '204': description: Response @@ -56762,17 +56807,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response content: application/json: - schema: *397 + schema: *401 examples: - default: &401 + default: &405 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -56795,17 +56840,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response content: application/json: - schema: *397 + schema: *401 examples: - default: *401 + default: *405 '404': *6 x-github: githubCloudOnly: false @@ -56825,9 +56870,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '204': description: Response @@ -56852,17 +56897,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response content: application/json: - schema: *402 + schema: *406 examples: - default: &403 + default: &407 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -56888,9 +56933,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: false content: @@ -56942,9 +56987,9 @@ paths: description: Response content: application/json: - schema: *402 + schema: *406 examples: - default: *403 + default: *407 '404': *6 '422': *15 x-github: @@ -56966,9 +57011,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '204': description: Response @@ -56992,9 +57037,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response @@ -57028,9 +57073,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: false content: @@ -57097,9 +57142,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: false content: @@ -57163,9 +57208,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: content: application/json: @@ -57231,15 +57276,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response content: application/json: - schema: *396 + schema: *400 examples: default: value: @@ -57330,9 +57375,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '204': description: Response @@ -57355,9 +57400,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response @@ -57367,7 +57412,7 @@ paths: type: array items: *5 examples: - default: &404 + default: &408 value: - id: 1 slug: octoapp @@ -57424,9 +57469,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: true content: @@ -57460,7 +57505,7 @@ paths: type: array items: *5 examples: - default: *404 + default: *408 '422': *15 x-github: githubCloudOnly: false @@ -57481,9 +57526,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: true content: @@ -57517,7 +57562,7 @@ paths: type: array items: *5 examples: - default: *404 + default: *408 '422': *15 x-github: githubCloudOnly: false @@ -57538,9 +57583,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: true content: @@ -57574,7 +57619,7 @@ paths: type: array items: *5 examples: - default: *404 + default: *408 '422': *15 x-github: githubCloudOnly: false @@ -57596,9 +57641,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response @@ -57606,9 +57651,9 @@ paths: application/json: schema: type: array - items: *181 + items: *187 examples: - default: *236 + default: *242 '404': *6 x-github: githubCloudOnly: false @@ -57628,9 +57673,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: false content: @@ -57666,9 +57711,9 @@ paths: application/json: schema: type: array - items: *181 + items: *187 examples: - default: *236 + default: *242 '422': *15 x-github: githubCloudOnly: false @@ -57689,9 +57734,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: false content: @@ -57727,9 +57772,9 @@ paths: application/json: schema: type: array - items: *181 + items: *187 examples: - default: *236 + default: *242 '422': *15 x-github: githubCloudOnly: false @@ -57750,9 +57795,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: content: application/json: @@ -57787,9 +57832,9 @@ paths: application/json: schema: type: array - items: *181 + items: *187 examples: - default: *236 + default: *242 '422': *15 x-github: githubCloudOnly: false @@ -57811,9 +57856,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 responses: '200': description: Response @@ -57823,7 +57868,7 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 '404': *6 x-github: githubCloudOnly: false @@ -57847,9 +57892,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: true content: @@ -57882,7 +57927,7 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 '422': *15 x-github: githubCloudOnly: false @@ -57907,9 +57952,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: true content: @@ -57942,7 +57987,7 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 '422': *15 x-github: githubCloudOnly: false @@ -57967,9 +58012,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: true content: @@ -58002,7 +58047,7 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 '422': *15 x-github: githubCloudOnly: false @@ -58029,9 +58074,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 requestBody: required: true content: @@ -58053,7 +58098,7 @@ paths: description: Response content: application/json: - schema: *405 + schema: *409 examples: default: value: @@ -58169,8 +58214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -58449,7 +58494,7 @@ paths: description: Response content: application/json: - schema: &407 + schema: &411 title: CheckRun description: A check performed on the code of a given code change type: object @@ -58560,16 +58605,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *406 - deployment: &714 + items: *410 + deployment: &725 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -58636,8 +58681,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 required: - id - node_id @@ -58849,9 +58894,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *327 - - *328 - - &408 + - *332 + - *333 + - &412 name: check_run_id description: The unique identifier of the check run. in: path @@ -58863,9 +58908,9 @@ paths: description: Response content: application/json: - schema: *407 + schema: *411 examples: - default: &409 + default: &413 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -58965,9 +59010,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *327 - - *328 - - *408 + - *332 + - *333 + - *412 requestBody: required: true content: @@ -59207,9 +59252,9 @@ paths: description: Response content: application/json: - schema: *407 + schema: *411 examples: - default: *409 + default: *413 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59229,9 +59274,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *327 - - *328 - - *408 + - *332 + - *333 + - *412 - *17 - *19 responses: @@ -59306,7 +59351,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: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59326,15 +59371,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *327 - - *328 - - *408 + - *332 + - *333 + - *412 responses: '201': description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -59372,8 +59417,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -59395,7 +59440,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &412 + schema: &416 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -59459,7 +59504,7 @@ paths: nullable: true pull_requests: type: array - items: *406 + items: *410 nullable: true app: title: GitHub app @@ -59470,9 +59515,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 - repository: *143 + properties: *71 + required: *72 + repository: *149 created_at: type: string format: date-time @@ -59481,12 +59526,12 @@ paths: type: string format: date-time nullable: true - head_commit: &740 + head_commit: &751 title: Simple Commit description: A commit. type: object - properties: *410 - required: *411 + properties: *414 + required: *415 latest_check_runs_count: type: integer check_runs_url: @@ -59514,7 +59559,7 @@ paths: - check_runs_url - pull_requests examples: - default: &413 + default: &417 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -59805,9 +59850,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *412 + schema: *416 examples: - default: *413 + default: *417 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59826,8 +59871,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -59888,7 +59933,7 @@ paths: required: - app_id - setting - repository: *143 + repository: *149 examples: default: value: @@ -60136,9 +60181,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *327 - - *328 - - &414 + - *332 + - *333 + - &418 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -60150,9 +60195,9 @@ paths: description: Response content: application/json: - schema: *412 + schema: *416 examples: - default: *413 + default: *417 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60175,17 +60220,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *327 - - *328 - - *414 - - &464 + - *332 + - *333 + - *418 + - &468 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &465 + - &469 name: status description: Returns check runs with the specified `status`. in: query @@ -60224,9 +60269,9 @@ paths: type: integer check_runs: type: array - items: *407 + items: *411 examples: - default: &466 + default: &470 value: total_count: 1 check_runs: @@ -60308,7 +60353,7 @@ paths: url: https://api.github.com/repos/github/hello-world name: hello-world headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60328,15 +60373,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *327 - - *328 - - *414 + - *332 + - *333 + - *418 responses: '201': description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -60363,30 +60408,30 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *327 - - *328 - - *415 - - *416 + - *332 + - *333 + - *419 + - *420 - *19 - *17 - - &433 + - &437 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: *417 - - &434 + schema: *421 + - &438 name: pr description: The number of the pull request for the results you want to list. in: query required: false schema: type: integer - - *48 - - *40 - - *41 + - *52 + - *45 + - *46 - name: sort description: The property by which to sort the results. in: query @@ -60402,13 +60447,13 @@ paths: be returned. in: query required: false - schema: *418 + schema: *422 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *419 + schema: *423 responses: '200': description: Response @@ -60419,14 +60464,14 @@ paths: items: type: object properties: - number: *161 - created_at: *162 - updated_at: *163 - url: *164 - html_url: *165 - instances_url: *420 - state: *170 - fixed_at: *166 + number: *167 + created_at: *168 + updated_at: *169 + url: *170 + html_url: *171 + instances_url: *424 + state: *176 + fixed_at: *172 dismissed_by: title: Simple User description: A GitHub user. @@ -60434,12 +60479,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *167 - dismissed_reason: *421 - dismissed_comment: *422 - rule: *423 - tool: *424 - most_recent_instance: *425 + dismissed_at: *173 + dismissed_reason: *425 + dismissed_comment: *426 + rule: *427 + tool: *428 + most_recent_instance: *429 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -60565,14 +60610,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &426 + '403': &430 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60592,9 +60637,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *327 - - *328 - - &427 + - *332 + - *333 + - &431 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -60602,23 +60647,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *161 + schema: *167 responses: '200': description: Response content: application/json: - schema: &428 + schema: &432 type: object properties: - number: *161 - created_at: *162 - updated_at: *163 - url: *164 - html_url: *165 - instances_url: *420 - state: *170 - fixed_at: *166 + number: *167 + created_at: *168 + updated_at: *169 + url: *170 + html_url: *171 + instances_url: *424 + state: *176 + fixed_at: *172 dismissed_by: title: Simple User description: A GitHub user. @@ -60626,9 +60671,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *167 - dismissed_reason: *421 - dismissed_comment: *422 + dismissed_at: *173 + dismissed_reason: *425 + dismissed_comment: *426 rule: type: object properties: @@ -60682,8 +60727,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *424 - most_recent_instance: *425 + tool: *428 + most_recent_instance: *429 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -60782,9 +60827,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *426 + '403': *430 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60802,9 +60847,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *327 - - *328 - - *427 + - *332 + - *333 + - *431 requestBody: required: true content: @@ -60819,8 +60864,8 @@ paths: enum: - open - dismissed - dismissed_reason: *421 - dismissed_comment: *422 + dismissed_reason: *425 + dismissed_comment: *426 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -60839,7 +60884,7 @@ paths: description: Response content: application/json: - schema: *428 + schema: *432 examples: default: value: @@ -60915,14 +60960,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &432 + '403': &436 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': *104 + '503': *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -60942,15 +60987,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: - - *327 - - *328 - - *427 + - *332 + - *333 + - *431 responses: '200': description: Response content: application/json: - schema: &429 + schema: &433 type: object properties: status: @@ -60976,13 +61021,13 @@ paths: - description - started_at examples: - default: &430 + default: &434 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &431 + '400': &435 description: Bad Request content: application/json: @@ -60993,9 +61038,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': *426 + '403': *430 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61018,29 +61063,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: - - *327 - - *328 - - *427 + - *332 + - *333 + - *431 responses: '200': description: OK content: application/json: - schema: *429 + schema: *433 examples: - default: *430 + default: *434 '202': description: Accepted content: application/json: - schema: *429 + schema: *433 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *431 + '400': *435 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -61050,7 +61095,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61072,9 +61117,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: - - *327 - - *328 - - *427 + - *332 + - *333 + - *431 requestBody: required: false content: @@ -61119,12 +61164,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *431 - '403': *432 + '400': *435 + '403': *436 '404': *6 '422': description: Unprocessable Entity - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61144,13 +61189,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *327 - - *328 - - *427 + - *332 + - *333 + - *431 - *19 - *17 - - *433 - - *434 + - *437 + - *438 responses: '200': description: Response @@ -61158,7 +61203,7 @@ paths: application/json: schema: type: array - items: *425 + items: *429 examples: default: value: @@ -61197,9 +61242,9 @@ paths: end_column: 50 classifications: - source - '403': *426 + '403': *430 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61231,29 +61276,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *327 - - *328 - - *415 - - *416 + - *332 + - *333 + - *419 + - *420 - *19 - *17 - - *434 + - *438 - 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: *417 + schema: *421 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &437 + schema: &441 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 - - *48 + - *52 - name: sort description: The property by which to sort the results. in: query @@ -61270,23 +61315,23 @@ paths: application/json: schema: type: array - items: &438 + items: &442 type: object properties: - ref: *417 - commit_sha: &446 + ref: *421 + commit_sha: &450 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: *435 + analysis_key: *439 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *436 + category: *440 error: type: string example: error reading field xyz @@ -61310,8 +61355,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *437 - tool: *424 + sarif_id: *441 + tool: *428 deletable: type: boolean warning: @@ -61372,9 +61417,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *426 + '403': *430 '404': *6 - '503': *104 + '503': *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -61408,8 +61453,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: - - *327 - - *328 + - *332 + - *333 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -61422,7 +61467,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *442 examples: response: summary: application/json response @@ -61476,14 +61521,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *426 + '403': *430 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *104 + '503': *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -61563,8 +61608,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: - - *327 - - *328 + - *332 + - *333 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -61617,9 +61662,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': *432 + '403': *436 '404': *6 - '503': *104 + '503': *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -61639,8 +61684,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -61648,7 +61693,7 @@ paths: application/json: schema: type: array - items: &439 + items: &443 title: CodeQL Database description: A CodeQL database. type: object @@ -61759,9 +61804,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': *426 + '403': *430 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61788,8 +61833,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 - name: language in: path description: The language of the CodeQL database. @@ -61801,7 +61846,7 @@ paths: description: Response content: application/json: - schema: *439 + schema: *443 examples: default: value: @@ -61833,11 +61878,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': &473 + '302': &477 description: Found - '403': *426 + '403': *430 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61857,8 +61902,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *327 - - *328 + - *332 + - *333 - name: language in: path description: The language of the CodeQL database. @@ -61868,9 +61913,9 @@ paths: responses: '204': description: Response - '403': *432 + '403': *436 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61896,8 +61941,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -61906,7 +61951,7 @@ paths: type: object additionalProperties: false properties: - language: &440 + language: &444 type: string description: The language targeted by the CodeQL query enum: @@ -61986,7 +62031,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &444 + schema: &448 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -61994,9 +62039,9 @@ paths: id: type: integer description: The ID of the variant analysis. - controller_repo: *53 + controller_repo: *57 actor: *4 - query_language: *440 + query_language: *444 query_pack_url: type: string description: The download url for the query pack. @@ -62043,7 +62088,7 @@ paths: items: type: object properties: - repository: &441 + repository: &445 title: Repository Identifier description: Repository Identifier type: object @@ -62079,7 +62124,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &445 + analysis_status: &449 type: string description: The new status of the CodeQL variant analysis repository task. @@ -62111,7 +62156,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &442 + access_mismatch_repos: &446 type: object properties: repository_count: @@ -62125,7 +62170,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: *441 + items: *445 required: - repository_count - repositories @@ -62147,8 +62192,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *442 - over_limit_repos: *442 + no_codeql_db_repos: *446 + over_limit_repos: *446 required: - access_mismatch_repos - not_found_repos @@ -62164,7 +62209,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &443 + value: &447 summary: Default response value: id: 1 @@ -62316,17 +62361,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *443 + value: *447 repository_lists: summary: Response for a successful variant analysis submission - value: *443 + value: *447 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62347,8 +62392,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: - - *327 - - *328 + - *332 + - *333 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -62360,11 +62405,11 @@ paths: description: Response content: application/json: - schema: *444 + schema: *448 examples: - default: *443 + default: *447 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62385,7 +62430,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: - - *327 + - *332 - name: repo in: path description: The name of the controller repository. @@ -62419,8 +62464,8 @@ paths: schema: type: object properties: - repository: *53 - analysis_status: *445 + repository: *57 + analysis_status: *449 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -62524,7 +62569,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62545,8 +62590,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -62631,9 +62676,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *426 + '403': *430 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62652,8 +62697,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -62720,7 +62765,7 @@ paths: description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -62745,7 +62790,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *432 + '403': *436 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -62759,7 +62804,7 @@ paths: content: application/json: schema: *3 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62816,8 +62861,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -62825,7 +62870,7 @@ paths: schema: type: object properties: - commit_sha: *446 + commit_sha: *450 ref: type: string description: |- @@ -62883,7 +62928,7 @@ paths: schema: type: object properties: - id: *437 + id: *441 url: type: string description: The REST API URL for checking the status of the upload. @@ -62897,11 +62942,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': *432 + '403': *436 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *104 + '503': *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -62920,8 +62965,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *327 - - *328 + - *332 + - *333 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -62967,10 +63012,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': *426 + '403': *430 '404': description: Not Found if the sarif id does not match any upload - '503': *104 + '503': *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -62992,8 +63037,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: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -63017,7 +63062,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *43 + configuration: *47 examples: default: value: @@ -63049,7 +63094,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': *175 + '204': *181 '304': *37 '403': *29 '404': *6 @@ -63074,8 +63119,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *327 - - *328 + - *332 + - *333 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -63195,8 +63240,8 @@ paths: parameters: - *17 - *19 - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -63212,7 +63257,7 @@ paths: type: integer codespaces: type: array - items: *224 + items: *230 examples: default: value: @@ -63488,7 +63533,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': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -63510,8 +63555,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -63574,22 +63619,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *224 + schema: *230 examples: - default: *447 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *224 + schema: *230 examples: - default: *447 + default: *451 '400': *14 '401': *25 '403': *29 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63613,8 +63658,8 @@ paths: parameters: - *17 - *19 - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -63654,7 +63699,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *103 + '500': *109 '400': *14 '401': *25 '403': *29 @@ -63678,8 +63723,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -63714,14 +63759,14 @@ paths: type: integer machines: type: array - items: &669 + items: &671 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *448 - required: *449 + properties: *452 + required: *453 examples: - default: &670 + default: &672 value: total_count: 2 machines: @@ -63738,7 +63783,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *37 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -63761,8 +63806,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *327 - - *328 + - *332 + - *333 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -63846,8 +63891,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: - - *327 - - *328 + - *332 + - *333 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -63892,7 +63937,7 @@ paths: '403': *29 '404': *6 '422': *15 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63913,8 +63958,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -63932,7 +63977,7 @@ paths: type: integer secrets: type: array - items: &453 + items: &457 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -63952,9 +63997,9 @@ paths: - created_at - updated_at examples: - default: *450 + default: *454 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63975,16 +64020,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *451 + schema: *455 examples: - default: *452 + default: *456 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64004,17 +64049,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *327 - - *328 - - *151 + - *332 + - *333 + - *157 responses: '200': description: Response content: application/json: - schema: *453 + schema: *457 examples: - default: *454 + default: *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64034,9 +64079,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 - - *151 + - *332 + - *333 + - *157 requestBody: required: true content: @@ -64064,7 +64109,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -64088,9 +64133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *327 - - *328 - - *151 + - *332 + - *333 + - *157 responses: '204': description: Response @@ -64118,8 +64163,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *327 - - *328 + - *332 + - *333 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -64161,7 +64206,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &455 + properties: &459 login: type: string example: octocat @@ -64254,7 +64299,7 @@ paths: user_view_type: type: string example: public - required: &456 + required: &460 - avatar_url - events_url - followers_url @@ -64303,7 +64348,7 @@ paths: admin: false role_name: write headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -64328,9 +64373,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *327 - - *328 - - *59 + - *332 + - *333 + - *63 responses: '204': description: Response if user is a collaborator @@ -64376,9 +64421,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *327 - - *328 - - *59 + - *332 + - *333 + - *63 requestBody: required: false content: @@ -64404,7 +64449,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &522 + schema: &526 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -64415,7 +64460,7 @@ paths: example: 42 type: integer format: int64 - repository: *143 + repository: *149 invitee: title: Simple User description: A GitHub user. @@ -64593,7 +64638,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *112 + schema: *118 '403': *29 x-github: triggersNotification: true @@ -64633,9 +64678,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *327 - - *328 - - *59 + - *332 + - *333 + - *63 responses: '204': description: No Content when collaborator was removed from the repository. @@ -64666,9 +64711,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *327 - - *328 - - *59 + - *332 + - *333 + - *63 responses: '200': description: if user has admin permissions @@ -64688,8 +64733,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *455 - required: *456 + properties: *459 + required: *460 nullable: true required: - permission @@ -64744,8 +64789,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -64755,7 +64800,7 @@ paths: application/json: schema: type: array - items: &457 + items: &461 title: Commit Comment description: Commit Comment type: object @@ -64796,8 +64841,8 @@ paths: updated_at: type: string format: date-time - author_association: *69 - reactions: *70 + author_association: *73 + reactions: *74 required: - url - html_url @@ -64813,7 +64858,7 @@ paths: - created_at - updated_at examples: - default: &460 + default: &464 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -64847,7 +64892,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' author_association: COLLABORATOR headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64872,17 +64917,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 responses: '200': description: Response content: application/json: - schema: *457 + schema: *461 examples: - default: &461 + default: &465 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -64939,9 +64984,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 requestBody: required: true content: @@ -64963,7 +65008,7 @@ paths: description: Response content: application/json: - schema: *457 + schema: *461 examples: default: value: @@ -65014,9 +65059,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 responses: '204': description: Response @@ -65037,9 +65082,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. @@ -65065,11 +65110,11 @@ paths: application/json: schema: type: array - items: *320 + items: *327 examples: - default: *322 + default: *329 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -65088,9 +65133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 requestBody: required: true content: @@ -65122,16 +65167,16 @@ paths: description: Reaction exists content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '201': description: Reaction created content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '422': *15 x-github: githubCloudOnly: false @@ -65153,10 +65198,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *327 - - *328 - - *81 - - *323 + - *332 + - *333 + - *85 + - *330 responses: '204': description: Response @@ -65205,8 +65250,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *327 - - *328 + - *332 + - *333 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -65262,9 +65307,9 @@ paths: application/json: schema: type: array - items: *458 + items: *462 examples: - default: &575 + default: &579 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -65334,11 +65379,11 @@ paths: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: - Link: *54 - '500': *103 + Link: *58 + '500': *109 '400': *14 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65358,9 +65403,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *327 - - *328 - - &459 + - *332 + - *333 + - &463 name: commit_sha description: The SHA of the commit. in: path @@ -65407,7 +65452,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65432,9 +65477,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *327 - - *328 - - *459 + - *332 + - *333 + - *463 - *17 - *19 responses: @@ -65444,11 +65489,11 @@ paths: application/json: schema: type: array - items: *457 + items: *461 examples: - default: *460 + default: *464 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65474,9 +65519,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *327 - - *328 - - *459 + - *332 + - *333 + - *463 requestBody: required: true content: @@ -65511,9 +65556,9 @@ paths: description: Response content: application/json: - schema: *457 + schema: *461 examples: - default: *461 + default: *465 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -65541,9 +65586,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *327 - - *328 - - *459 + - *332 + - *333 + - *463 - *17 - *19 responses: @@ -65553,9 +65598,9 @@ paths: application/json: schema: type: array - items: *462 + items: *466 examples: - default: &567 + default: &571 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -66034,8 +66079,8 @@ paths: auto_merge: draft: false headers: - Link: *54 - '409': *47 + Link: *58 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66092,11 +66137,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *327 - - *328 + - *332 + - *333 - *19 - *17 - - &463 + - &467 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -66111,9 +66156,9 @@ paths: description: Response content: application/json: - schema: *458 + schema: *462 examples: - default: &552 + default: &556 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -66199,9 +66244,9 @@ paths: ..... '422': *15 '404': *6 - '500': *103 - '503': *104 - '409': *47 + '500': *109 + '503': *110 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66226,11 +66271,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *327 - - *328 - - *463 - - *464 - - *465 + - *332 + - *333 + - *467 + - *468 + - *469 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -66264,11 +66309,11 @@ paths: type: integer check_runs: type: array - items: *407 + items: *411 examples: - default: *466 + default: *470 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66291,9 +66336,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *327 - - *328 - - *463 + - *332 + - *333 + - *467 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -66301,7 +66346,7 @@ paths: schema: type: integer example: 1 - - *464 + - *468 - *17 - *19 responses: @@ -66319,7 +66364,7 @@ paths: type: integer check_suites: type: array - items: *412 + items: *416 examples: default: value: @@ -66494,7 +66539,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: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66519,9 +66564,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *327 - - *328 - - *463 + - *332 + - *333 + - *467 - *17 - *19 responses: @@ -66588,7 +66633,7 @@ paths: type: string total_count: type: integer - repository: *143 + repository: *149 commit_url: type: string format: uri @@ -66719,9 +66764,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *327 - - *328 - - *463 + - *332 + - *333 + - *467 - *17 - *19 responses: @@ -66731,7 +66776,7 @@ paths: application/json: schema: type: array - items: &640 + items: &644 title: Status description: The status of a commit. type: object @@ -66811,8 +66856,8 @@ paths: type: User site_admin: false headers: - Link: *54 - '301': *334 + Link: *58 + '301': *336 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66840,8 +66885,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -66870,20 +66915,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *467 - required: *468 + properties: *471 + required: *472 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &469 + properties: &473 url: type: string format: uri html_url: type: string format: uri - required: &470 + required: &474 - url - html_url nullable: true @@ -66891,32 +66936,32 @@ paths: title: License Simple description: License Simple type: object - properties: *83 - required: *84 + properties: *87 + required: *88 nullable: true contributing: title: Community Health File type: object - properties: *469 - required: *470 + properties: *473 + required: *474 nullable: true readme: title: Community Health File type: object - properties: *469 - required: *470 + properties: *473 + required: *474 nullable: true issue_template: title: Community Health File type: object - properties: *469 - required: *470 + properties: *473 + required: *474 nullable: true pull_request_template: title: Community Health File type: object - properties: *469 - required: *470 + properties: *473 + required: *474 nullable: true required: - code_of_conduct @@ -67043,8 +67088,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *327 - - *328 + - *332 + - *333 - *19 - *17 - name: basehead @@ -67087,8 +67132,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *458 - merge_base_commit: *458 + base_commit: *462 + merge_base_commit: *462 status: type: string enum: @@ -67108,10 +67153,10 @@ paths: example: 6 commits: type: array - items: *458 + items: *462 files: type: array - items: *471 + items: *475 required: - url - html_url @@ -67354,8 +67399,8 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *6 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67397,8 +67442,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *327 - - *328 + - *332 + - *333 - name: path description: path parameter in: path @@ -67541,7 +67586,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &472 + response-if-content-is-a-file: &476 summary: Response if content is a file value: type: file @@ -67673,7 +67718,7 @@ paths: - size - type - url - - &580 + - &584 title: Content File description: Content File type: object @@ -67874,7 +67919,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *472 + response-if-content-is-a-file: *476 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -67943,7 +67988,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *473 + '302': *477 '304': *37 x-github: githubCloudOnly: false @@ -67966,8 +68011,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *327 - - *328 + - *332 + - *333 - name: path description: path parameter in: path @@ -68060,7 +68105,7 @@ paths: description: Response content: application/json: - schema: &474 + schema: &478 title: File Commit description: File Commit type: object @@ -68212,7 +68257,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *478 examples: example-for-creating-a-file: value: @@ -68266,7 +68311,7 @@ paths: schema: oneOf: - *3 - - &504 + - &508 description: Repository rule violation was detected type: object properties: @@ -68287,7 +68332,7 @@ paths: items: type: object properties: - placeholder_id: &632 + placeholder_id: &636 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -68319,8 +68364,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *327 - - *328 + - *332 + - *333 - name: path description: path parameter in: path @@ -68381,7 +68426,7 @@ paths: description: Response content: application/json: - schema: *474 + schema: *478 examples: default: value: @@ -68415,8 +68460,8 @@ paths: verified_at: '422': *15 '404': *6 - '409': *47 - '503': *104 + '409': *51 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68436,8 +68481,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *327 - - *328 + - *332 + - *333 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -68537,7 +68582,7 @@ paths: site_admin: false contributions: 32 headers: - Link: *54 + Link: *58 '204': description: Response if repository is empty '403': *29 @@ -68560,23 +68605,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *327 - - *328 - - *182 - - *183 - - *184 - - *185 + - *332 + - *333 + - *188 + - *189 + - *190 + - *191 - 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 - - *186 - - *475 - - *187 - - *188 - - *48 + - *192 + - *479 + - *193 + - *194 + - *52 - 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)." @@ -68585,8 +68630,8 @@ paths: schema: type: integer default: 30 - - *40 - - *41 + - *45 + - *46 responses: '200': description: Response @@ -68594,11 +68639,11 @@ paths: application/json: schema: type: array - items: &478 + items: &482 type: object description: A Dependabot alert. properties: - number: *161 + number: *167 state: type: string description: The state of the Dependabot alert. @@ -68613,7 +68658,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: *49 + package: *53 manifest_path: type: string description: The full path to the dependency manifest file, @@ -68640,13 +68685,13 @@ paths: - unknown - direct - transitive - security_advisory: *476 - security_vulnerability: *52 - url: *164 - html_url: *165 - created_at: *162 - updated_at: *163 - dismissed_at: *167 + security_advisory: *480 + security_vulnerability: *56 + url: *170 + html_url: *171 + created_at: *168 + updated_at: *169 + dismissed_at: *173 dismissed_by: title: Simple User description: A GitHub user. @@ -68670,8 +68715,8 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *166 - auto_dismissed_at: *477 + fixed_at: *172 + auto_dismissed_at: *481 required: - number - state @@ -68901,9 +68946,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *327 - - *328 - - &479 + - *332 + - *333 + - &483 name: alert_number in: path description: |- @@ -68912,13 +68957,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *161 + schema: *167 responses: '200': description: Response content: application/json: - schema: *478 + schema: *482 examples: default: value: @@ -69031,9 +69076,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *327 - - *328 - - *479 + - *332 + - *333 + - *483 requestBody: required: true content: @@ -69078,7 +69123,7 @@ paths: description: Response content: application/json: - schema: *478 + schema: *482 examples: default: value: @@ -69184,7 +69229,7 @@ paths: '400': *14 '403': *29 '404': *6 - '409': *47 + '409': *51 '422': *7 x-github: githubCloudOnly: false @@ -69207,8 +69252,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -69226,7 +69271,7 @@ paths: type: integer secrets: type: array - items: &482 + items: &486 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -69257,7 +69302,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69279,16 +69324,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *480 + schema: *484 examples: - default: *481 + default: *485 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69308,15 +69353,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *327 - - *328 - - *151 + - *332 + - *333 + - *157 responses: '200': description: Response content: application/json: - schema: *482 + schema: *486 examples: default: value: @@ -69342,9 +69387,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *327 - - *328 - - *151 + - *332 + - *333 + - *157 requestBody: required: true content: @@ -69372,7 +69417,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -69396,9 +69441,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *327 - - *328 - - *151 + - *332 + - *333 + - *157 responses: '204': description: Response @@ -69420,8 +69465,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: - - *327 - - *328 + - *332 + - *333 - 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 @@ -69557,7 +69602,7 @@ paths: advisory_summary: Ruby OpenID advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 headers: - Link: *54 + Link: *58 '404': *6 '403': description: Response for a private repository when GitHub Advanced Security @@ -69581,8 +69626,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: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -69798,7 +69843,7 @@ paths: spdxElementId: SPDXRef-DOCUMENT relatedSpdxElement: SPDXRef-Repository headers: - Link: *54 + Link: *58 '404': *6 '403': *29 x-github: @@ -69821,8 +69866,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: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -69897,7 +69942,7 @@ paths: - version - url additionalProperties: false - metadata: &483 + metadata: &487 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -69930,7 +69975,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *483 + metadata: *487 resolved: type: object description: A collection of resolved package dependencies. @@ -69943,7 +69988,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *483 + metadata: *487 relationship: type: string description: A notation of whether a dependency is requested @@ -70072,8 +70117,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *327 - - *328 + - *332 + - *333 - name: sha description: The SHA recorded at creation time. in: query @@ -70113,11 +70158,11 @@ paths: application/json: schema: type: array - items: *484 + items: *488 examples: - default: *485 + default: *489 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70181,8 +70226,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -70263,7 +70308,7 @@ paths: description: Response content: application/json: - schema: *484 + schema: *488 examples: simple-example: summary: Simple example @@ -70336,9 +70381,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *327 - - *328 - - &486 + - *332 + - *333 + - &490 name: deployment_id description: deployment_id parameter in: path @@ -70350,7 +70395,7 @@ paths: description: Response content: application/json: - schema: *484 + schema: *488 examples: default: value: @@ -70415,9 +70460,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *327 - - *328 - - *486 + - *332 + - *333 + - *490 responses: '204': description: Response @@ -70439,9 +70484,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *327 - - *328 - - *486 + - *332 + - *333 + - *490 - *17 - *19 responses: @@ -70451,7 +70496,7 @@ paths: application/json: schema: type: array - items: &487 + items: &491 title: Deployment Status description: The status of a deployment. type: object @@ -70542,8 +70587,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 required: - id - node_id @@ -70592,7 +70637,7 @@ paths: environment_url: https://test-branch.lab.acme.com log_url: https://example.com/deployment/42/output headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -70612,9 +70657,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *327 - - *328 - - *486 + - *332 + - *333 + - *490 requestBody: required: true content: @@ -70689,9 +70734,9 @@ paths: description: Response content: application/json: - schema: *487 + schema: *491 examples: - default: &488 + default: &492 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -70747,9 +70792,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *327 - - *328 - - *486 + - *332 + - *333 + - *490 - name: status_id in: path required: true @@ -70760,9 +70805,9 @@ paths: description: Response content: application/json: - schema: *487 + schema: *491 examples: - default: *488 + default: *492 '404': *6 x-github: githubCloudOnly: false @@ -70787,8 +70832,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -70845,8 +70890,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -70863,7 +70908,7 @@ paths: type: integer environments: type: array - items: &490 + items: &494 title: Environment description: Details of a deployment environment type: object @@ -70915,7 +70960,7 @@ paths: type: type: string example: wait_timer - wait_timer: &492 + wait_timer: &496 type: integer example: 30 description: The amount of time to delay a job after @@ -70952,11 +70997,11 @@ paths: items: type: object properties: - type: *489 + type: *493 reviewer: anyOf: - *4 - - *181 + - *187 required: - id - node_id @@ -70976,7 +71021,7 @@ paths: - id - node_id - type - deployment_branch_policy: &493 + deployment_branch_policy: &497 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -71092,9 +71137,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *327 - - *328 - - &491 + - *332 + - *333 + - &495 name: environment_name in: path required: true @@ -71107,9 +71152,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *494 examples: - default: &494 + default: &498 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -71193,9 +71238,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *327 - - *328 - - *491 + - *332 + - *333 + - *495 requestBody: required: false content: @@ -71204,7 +71249,7 @@ paths: type: object nullable: true properties: - wait_timer: *492 + wait_timer: *496 prevent_self_review: type: boolean example: false @@ -71221,13 +71266,13 @@ paths: items: type: object properties: - type: *489 + type: *493 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *493 + deployment_branch_policy: *497 additionalProperties: false examples: default: @@ -71247,9 +71292,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *494 examples: - default: *494 + default: *498 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -71273,9 +71318,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *327 - - *328 - - *491 + - *332 + - *333 + - *495 responses: '204': description: Default response @@ -71300,9 +71345,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *327 - - *328 - - *491 + - *332 + - *333 + - *495 - *17 - *19 responses: @@ -71320,7 +71365,7 @@ paths: example: 2 branch_policies: type: array - items: &495 + items: &499 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -71377,9 +71422,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *327 - - *328 - - *491 + - *332 + - *333 + - *495 requestBody: required: true content: @@ -71425,9 +71470,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *499 examples: - example-wildcard: &496 + example-wildcard: &500 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -71469,10 +71514,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *327 - - *328 - - *491 - - &497 + - *332 + - *333 + - *495 + - &501 name: branch_policy_id in: path required: true @@ -71484,9 +71529,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *499 examples: - default: *496 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71505,10 +71550,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *327 - - *328 - - *491 - - *497 + - *332 + - *333 + - *495 + - *501 requestBody: required: true content: @@ -71536,9 +71581,9 @@ paths: description: Response content: application/json: - schema: *495 + schema: *499 examples: - default: *496 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71557,10 +71602,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *327 - - *328 - - *491 - - *497 + - *332 + - *333 + - *495 + - *501 responses: '204': description: Response @@ -71585,9 +71630,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *491 - - *328 - - *327 + - *495 + - *333 + - *332 responses: '200': description: List of deployment protection rules @@ -71603,7 +71648,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &498 + items: &502 title: Deployment protection rule description: Deployment protection rule type: object @@ -71622,7 +71667,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &499 + app: &503 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -71721,9 +71766,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: - - *491 - - *328 - - *327 + - *495 + - *333 + - *332 requestBody: content: application/json: @@ -71744,9 +71789,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *498 + schema: *502 examples: - default: &500 + default: &504 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -71781,9 +71826,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: - - *491 - - *328 - - *327 + - *495 + - *333 + - *332 - *19 - *17 responses: @@ -71802,7 +71847,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *499 + items: *503 examples: default: value: @@ -71837,10 +71882,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *327 - - *328 - - *491 - - &501 + - *332 + - *333 + - *495 + - &505 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -71852,9 +71897,9 @@ paths: description: Response content: application/json: - schema: *498 + schema: *502 examples: - default: *500 + default: *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71875,10 +71920,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *491 - - *328 - - *327 - - *501 + - *495 + - *333 + - *332 + - *505 responses: '204': description: Response @@ -71904,9 +71949,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *327 - - *328 - - *491 + - *332 + - *333 + - *495 - *17 - *19 responses: @@ -71924,11 +71969,11 @@ paths: type: integer secrets: type: array - items: *373 + items: *377 examples: - default: *374 + default: *378 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71951,17 +71996,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *327 - - *328 - - *491 + - *332 + - *333 + - *495 responses: '200': description: Response content: application/json: - schema: *375 + schema: *379 examples: - default: *376 + default: *380 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71983,18 +72028,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *327 - - *328 - - *491 - - *151 + - *332 + - *333 + - *495 + - *157 responses: '200': description: Response content: application/json: - schema: *373 + schema: *377 examples: - default: *502 + default: *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72016,10 +72061,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *327 - - *328 - - *491 - - *151 + - *332 + - *333 + - *495 + - *157 requestBody: required: true content: @@ -72050,7 +72095,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -72076,10 +72121,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *327 - - *328 - - *491 - - *151 + - *332 + - *333 + - *495 + - *157 responses: '204': description: Default response @@ -72104,10 +72149,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *327 - - *328 - - *491 - - *344 + - *332 + - *333 + - *495 + - *348 - *19 responses: '200': @@ -72124,11 +72169,11 @@ paths: type: integer variables: type: array - items: *377 + items: *381 examples: - default: *378 + default: *382 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72149,9 +72194,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *327 - - *328 - - *491 + - *332 + - *333 + - *495 requestBody: required: true content: @@ -72178,7 +72223,7 @@ paths: description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -72203,18 +72248,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *327 - - *328 - - *491 - - *154 + - *332 + - *333 + - *495 + - *160 responses: '200': description: Response content: application/json: - schema: *377 + schema: *381 examples: - default: *503 + default: *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72235,10 +72280,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *327 - - *328 - - *154 - - *491 + - *332 + - *333 + - *160 + - *495 requestBody: required: true content: @@ -72280,10 +72325,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *327 - - *328 - - *154 - - *491 + - *332 + - *333 + - *160 + - *495 responses: '204': description: Response @@ -72305,8 +72350,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -72316,7 +72361,7 @@ paths: application/json: schema: type: array - items: *94 + items: *98 examples: 200-response: value: @@ -72374,8 +72419,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *327 - - *328 + - *332 + - *333 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -72397,7 +72442,7 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: default: value: @@ -72510,7 +72555,7 @@ paths: url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== headers: - Link: *54 + Link: *58 '400': *14 x-github: githubCloudOnly: false @@ -72534,8 +72579,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: false content: @@ -72567,9 +72612,9 @@ paths: description: Response content: application/json: - schema: *333 + schema: *335 examples: - default: *335 + default: *337 '400': *14 '422': *15 '403': *29 @@ -72590,8 +72635,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -72642,7 +72687,7 @@ paths: schema: type: string '404': *6 - '409': *47 + '409': *51 '403': *29 '422': description: Validation failed @@ -72650,8 +72695,8 @@ paths: application/json: schema: oneOf: - - *112 - - *504 + - *118 + - *508 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72676,8 +72721,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *327 - - *328 + - *332 + - *333 - name: file_sha in: path required: true @@ -72728,7 +72773,7 @@ paths: '404': *6 '422': *15 '403': *29 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72776,8 +72821,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -72886,7 +72931,7 @@ paths: description: Response content: application/json: - schema: &505 + schema: &509 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -73050,7 +73095,7 @@ paths: type: string '422': *15 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73100,15 +73145,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *327 - - *328 - - *459 + - *332 + - *333 + - *463 responses: '200': description: Response content: application/json: - schema: *505 + schema: *509 examples: default: value: @@ -73139,7 +73184,7 @@ paths: payload: verified_at: '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73164,9 +73209,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *327 - - *328 - - &506 + - *332 + - *333 + - &510 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. @@ -73183,7 +73228,7 @@ paths: application/json: schema: type: array - items: &507 + items: &511 title: Git Reference description: Git references within a repository type: object @@ -73236,8 +73281,8 @@ paths: sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: - Link: *54 - '409': *47 + Link: *58 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73258,17 +73303,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *327 - - *328 - - *506 + - *332 + - *333 + - *510 responses: '200': description: Response content: application/json: - schema: *507 + schema: *511 examples: - default: &508 + default: &512 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -73278,7 +73323,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73297,8 +73342,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -73327,16 +73372,16 @@ paths: description: Response content: application/json: - schema: *507 + schema: *511 examples: - default: *508 + default: *512 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73355,9 +73400,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *327 - - *328 - - *506 + - *332 + - *333 + - *510 requestBody: required: true content: @@ -73386,11 +73431,11 @@ paths: description: Response content: application/json: - schema: *507 + schema: *511 examples: - default: *508 + default: *512 '422': *15 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73406,16 +73451,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *327 - - *328 - - *506 + - *332 + - *333 + - *510 responses: '204': description: Response '422': description: Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73463,8 +73508,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -73531,7 +73576,7 @@ paths: description: Response content: application/json: - schema: &510 + schema: &514 title: Git Tag description: Metadata for a Git tag type: object @@ -73582,7 +73627,7 @@ paths: - sha - type - url - verification: *509 + verification: *513 required: - sha - url @@ -73592,7 +73637,7 @@ paths: - tag - message examples: - default: &511 + default: &515 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -73619,7 +73664,7 @@ paths: schema: type: string '422': *15 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73665,8 +73710,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *327 - - *328 + - *332 + - *333 - name: tag_sha in: path required: true @@ -73677,11 +73722,11 @@ paths: description: Response content: application/json: - schema: *510 + schema: *514 examples: - default: *511 + default: *515 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73703,8 +73748,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -73777,7 +73822,7 @@ paths: description: Response content: application/json: - schema: &512 + schema: &516 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -73850,7 +73895,7 @@ paths: '422': *15 '404': *6 '403': *29 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73873,8 +73918,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *327 - - *328 + - *332 + - *333 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -73897,7 +73942,7 @@ paths: description: Response content: application/json: - schema: *512 + schema: *516 examples: default-response: summary: Default response @@ -73938,7 +73983,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73956,8 +74001,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -73967,7 +74012,7 @@ paths: application/json: schema: type: array - items: &513 + items: &517 title: Webhook description: Webhooks for repositories. type: object @@ -74021,7 +74066,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &748 + last_response: &759 title: Hook Response type: object properties: @@ -74076,7 +74121,7 @@ paths: status: unused message: headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -74095,8 +74140,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: false content: @@ -74148,9 +74193,9 @@ paths: description: Response content: application/json: - schema: *513 + schema: *517 examples: - default: &514 + default: &518 value: type: Repository id: 12345678 @@ -74198,17 +74243,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 responses: '200': description: Response content: application/json: - schema: *513 + schema: *517 examples: - default: *514 + default: *518 '404': *6 x-github: githubCloudOnly: false @@ -74228,9 +74273,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 requestBody: required: true content: @@ -74275,9 +74320,9 @@ paths: description: Response content: application/json: - schema: *513 + schema: *517 examples: - default: *514 + default: *518 '422': *15 '404': *6 x-github: @@ -74298,9 +74343,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 responses: '204': description: Response @@ -74324,9 +74369,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 responses: '200': description: Response @@ -74353,9 +74398,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 requestBody: required: false content: @@ -74399,11 +74444,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 - *17 - - *197 + - *203 responses: '200': description: Response @@ -74411,9 +74456,9 @@ paths: application/json: schema: type: array - items: *198 + items: *204 examples: - default: *199 + default: *205 '400': *14 '422': *15 x-github: @@ -74432,18 +74477,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 - *16 responses: '200': description: Response content: application/json: - schema: *200 + schema: *206 examples: - default: *201 + default: *207 '400': *14 '422': *15 x-github: @@ -74462,9 +74507,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 - *16 responses: '202': *39 @@ -74487,9 +74532,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 responses: '204': description: Response @@ -74514,9 +74559,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *327 - - *328 - - *196 + - *332 + - *333 + - *202 responses: '204': description: Response @@ -74539,8 +74584,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response if immutable releases are enabled @@ -74586,11 +74631,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *327 - - *328 + - *332 + - *333 responses: - '204': *175 - '409': *47 + '204': *181 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74607,11 +74652,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *327 - - *328 + - *332 + - *333 responses: - '204': *175 - '409': *47 + '204': *181 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74665,14 +74710,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: &515 + schema: &519 title: Import description: A repository import from an external source. type: object @@ -74771,7 +74816,7 @@ paths: - html_url - authors_url examples: - default: &518 + default: &522 value: vcs: subversion use_lfs: true @@ -74787,7 +74832,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': &516 + '503': &520 description: Unavailable due to service under maintenance. content: application/json: @@ -74816,8 +74861,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -74865,7 +74910,7 @@ paths: description: Response content: application/json: - schema: *515 + schema: *519 examples: default: value: @@ -74890,7 +74935,7 @@ paths: type: string '422': *15 '404': *6 - '503': *516 + '503': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74918,8 +74963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: false content: @@ -74968,7 +75013,7 @@ paths: description: Response content: application/json: - schema: *515 + schema: *519 examples: example-1: summary: Example 1 @@ -75016,7 +75061,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': *516 + '503': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75039,12 +75084,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response - '503': *516 + '503': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75070,9 +75115,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *327 - - *328 - - &691 + - *332 + - *333 + - &693 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -75086,7 +75131,7 @@ paths: application/json: schema: type: array - items: &517 + items: &521 title: Porter Author description: Porter Author type: object @@ -75140,7 +75185,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': *516 + '503': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75165,8 +75210,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *327 - - *328 + - *332 + - *333 - name: author_id in: path required: true @@ -75196,7 +75241,7 @@ paths: description: Response content: application/json: - schema: *517 + schema: *521 examples: default: value: @@ -75209,7 +75254,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *516 + '503': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75233,8 +75278,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -75275,7 +75320,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *516 + '503': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75303,8 +75348,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -75331,11 +75376,11 @@ paths: description: Response content: application/json: - schema: *515 + schema: *519 examples: - default: *518 + default: *522 '422': *15 - '503': *516 + '503': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75358,8 +75403,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -75367,8 +75412,8 @@ paths: application/json: schema: *22 examples: - default: *519 - '301': *334 + default: *523 + '301': *336 '404': *6 x-github: githubCloudOnly: false @@ -75388,8 +75433,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -75397,12 +75442,12 @@ paths: application/json: schema: anyOf: - - *214 + - *220 - type: object properties: {} additionalProperties: false examples: - default: &521 + default: &525 value: limit: collaborators_only origin: repository @@ -75427,13 +75472,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: application/json: - schema: *520 + schema: *524 examples: default: summary: Example request body @@ -75445,9 +75490,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *220 examples: - default: *521 + default: *525 '409': description: Response x-github: @@ -75469,8 +75514,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -75493,8 +75538,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -75504,9 +75549,9 @@ paths: application/json: schema: type: array - items: *522 + items: *526 examples: - default: &684 + default: &686 value: - id: 1 repository: @@ -75620,7 +75665,7 @@ paths: html_url: https://github.com/octocat/Hello-World/invitations node_id: MDQ6VXNlcjE= headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75637,9 +75682,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *327 - - *328 - - *218 + - *332 + - *333 + - *224 requestBody: required: false content: @@ -75668,7 +75713,7 @@ paths: description: Response content: application/json: - schema: *522 + schema: *526 examples: default: value: @@ -75799,9 +75844,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *327 - - *328 - - *218 + - *332 + - *333 + - *224 responses: '204': description: Response @@ -75832,8 +75877,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *327 - - *328 + - *332 + - *333 - 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 @@ -75881,7 +75926,7 @@ paths: required: false schema: type: string - - *222 + - *228 - name: sort description: What to sort results by. in: query @@ -75893,8 +75938,8 @@ paths: - updated - comments default: created - - *48 - - *72 + - *52 + - *76 - *17 - *19 responses: @@ -75904,9 +75949,9 @@ paths: application/json: schema: type: array - items: *82 + items: *86 examples: - default: &532 + default: &536 value: - id: 1 node_id: MDU6SXNzdWUx @@ -76053,8 +76098,8 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *54 - '301': *334 + Link: *58 + '301': *336 '422': *15 '404': *6 x-github: @@ -76083,8 +76128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -76166,9 +76211,9 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: &529 + default: &533 value: id: 1 node_id: MDU6SXNzdWUx @@ -76322,9 +76367,9 @@ paths: '400': *14 '403': *29 '422': *15 - '503': *104 + '503': *110 '404': *6 - '410': *523 + '410': *527 x-github: triggersNotification: true githubCloudOnly: false @@ -76352,9 +76397,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *327 - - *328 - - *92 + - *332 + - *333 + - *96 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -76364,7 +76409,7 @@ paths: enum: - asc - desc - - *72 + - *76 - *17 - *19 responses: @@ -76374,9 +76419,9 @@ paths: application/json: schema: type: array - items: *524 + items: *528 examples: - default: &531 + default: &535 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -76407,7 +76452,7 @@ paths: issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR headers: - Link: *54 + Link: *58 '422': *15 '404': *6 x-github: @@ -76434,17 +76479,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 responses: '200': description: Response content: application/json: - schema: *524 + schema: *528 examples: - default: &525 + default: &529 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -76498,9 +76543,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 requestBody: required: true content: @@ -76522,9 +76567,9 @@ paths: description: Response content: application/json: - schema: *524 + schema: *528 examples: - default: *525 + default: *529 '422': *15 x-github: githubCloudOnly: false @@ -76542,9 +76587,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 responses: '204': description: Response @@ -76564,9 +76609,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 - 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. @@ -76592,11 +76637,11 @@ paths: application/json: schema: type: array - items: *320 + items: *327 examples: - default: *322 + default: *329 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -76615,9 +76660,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 requestBody: required: true content: @@ -76649,16 +76694,16 @@ paths: description: Reaction exists content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '201': description: Reaction created content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '422': *15 x-github: githubCloudOnly: false @@ -76680,10 +76725,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *327 - - *328 - - *81 - - *323 + - *332 + - *333 + - *85 + - *330 responses: '204': description: Response @@ -76703,8 +76748,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -76714,7 +76759,7 @@ paths: application/json: schema: type: array - items: &528 + items: &532 title: Issue Event description: Issue Event type: object @@ -76757,8 +76802,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *526 - required: *527 + properties: *530 + required: *531 nullable: true label: title: Issue Event Label @@ -76802,7 +76847,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *181 + requested_team: *187 dismissed_review: title: Issue Event Dismissed Review type: object @@ -76867,7 +76912,7 @@ paths: required: - from - to - author_association: *69 + author_association: *73 lock_reason: type: string nullable: true @@ -76880,8 +76925,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 required: - id - node_id @@ -77047,7 +77092,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *54 + Link: *58 '422': *15 x-github: githubCloudOnly: false @@ -77065,8 +77110,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *327 - - *328 + - *332 + - *333 - name: event_id in: path required: true @@ -77077,7 +77122,7 @@ paths: description: Response content: application/json: - schema: *528 + schema: *532 examples: default: value: @@ -77270,7 +77315,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *523 + '410': *527 '403': *29 x-github: githubCloudOnly: false @@ -77304,9 +77349,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *327 - - *328 - - &530 + - *332 + - *333 + - &534 name: issue_number description: The number that identifies the issue. in: path @@ -77318,12 +77363,12 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 - '301': *334 + default: *533 + '301': *336 '404': *6 - '410': *523 + '410': *527 '304': *37 x-github: githubCloudOnly: false @@ -77348,9 +77393,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: false content: @@ -77454,15 +77499,15 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 + default: *533 '422': *15 - '503': *104 + '503': *110 '403': *29 - '301': *334 + '301': *336 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77480,9 +77525,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: false content: @@ -77508,9 +77553,9 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 + default: *533 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77526,9 +77571,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: content: application/json: @@ -77553,9 +77598,9 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 + default: *533 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77577,9 +77622,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: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - name: assignee in: path required: true @@ -77619,10 +77664,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *327 - - *328 - - *530 - - *72 + - *332 + - *333 + - *534 + - *76 - *17 - *19 responses: @@ -77632,13 +77677,13 @@ paths: application/json: schema: type: array - items: *524 + items: *528 examples: - default: *531 + default: *535 headers: - Link: *54 + Link: *58 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77667,9 +77712,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: true content: @@ -77691,16 +77736,16 @@ paths: description: Response content: application/json: - schema: *524 + schema: *528 examples: - default: *525 + default: *529 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *523 + '410': *527 '422': *15 '404': *6 x-github: @@ -77728,9 +77773,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - *17 - *19 responses: @@ -77740,14 +77785,14 @@ paths: application/json: schema: type: array - items: *82 + items: *86 examples: - default: *532 + default: *536 headers: - Link: *54 - '301': *334 + Link: *58 + '301': *336 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77775,9 +77820,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: true content: @@ -77799,17 +77844,17 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 + default: *533 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *334 + '301': *336 '403': *29 - '410': *523 + '410': *527 '422': *15 '404': *6 x-github: @@ -77840,9 +77885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -77854,15 +77899,15 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 - '301': *334 + default: *533 + '301': *336 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *523 + '410': *527 x-github: triggersNotification: true githubCloudOnly: false @@ -77888,9 +77933,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - *17 - *19 responses: @@ -77900,14 +77945,14 @@ paths: application/json: schema: type: array - items: *82 + items: *86 examples: - default: *532 + default: *536 headers: - Link: *54 - '301': *334 + Link: *58 + '301': *336 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77924,9 +77969,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - *17 - *19 responses: @@ -77940,7 +77985,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &535 + - &539 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -77971,8 +78016,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 label: type: object properties: @@ -77994,7 +78039,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &536 + - &540 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -78025,8 +78070,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 label: type: object properties: @@ -78114,8 +78159,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 assignee: *4 assigner: *4 required: @@ -78130,7 +78175,7 @@ paths: - performed_via_github_app - assignee - assigner - - &537 + - &541 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -78161,8 +78206,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 milestone: type: object properties: @@ -78181,7 +78226,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &538 + - &542 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -78212,8 +78257,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 milestone: type: object properties: @@ -78232,7 +78277,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &539 + - &543 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -78263,8 +78308,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 rename: type: object properties: @@ -78286,7 +78331,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &540 + - &544 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -78317,10 +78362,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 review_requester: *4 - requested_team: *181 + requested_team: *187 requested_reviewer: *4 required: - review_requester @@ -78333,7 +78378,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &541 + - &545 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -78364,10 +78409,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 review_requester: *4 - requested_team: *181 + requested_team: *187 requested_reviewer: *4 required: - review_requester @@ -78380,7 +78425,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &542 + - &546 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -78411,8 +78456,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 dismissed_review: type: object properties: @@ -78440,7 +78485,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &543 + - &547 title: Locked Issue Event description: Locked Issue Event type: object @@ -78471,8 +78516,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 lock_reason: type: string example: '"off-topic"' @@ -78488,7 +78533,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &544 + - &548 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -78519,8 +78564,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 project_card: type: object properties: @@ -78554,7 +78599,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &545 + - &549 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -78585,8 +78630,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 project_card: type: object properties: @@ -78620,7 +78665,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &546 + - &550 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -78651,8 +78696,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 project_card: type: object properties: @@ -78686,7 +78731,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &547 + - &551 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -78776,8 +78821,8 @@ paths: name: label color: red headers: - Link: *54 - '410': *523 + Link: *58 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78794,9 +78839,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - *17 - *19 responses: @@ -78806,7 +78851,7 @@ paths: application/json: schema: type: array - items: &533 + items: &537 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -78853,7 +78898,7 @@ paths: - color - default examples: - default: &534 + default: &538 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -78870,10 +78915,10 @@ paths: color: a2eeef default: false headers: - Link: *54 - '301': *334 + Link: *58 + '301': *336 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78890,9 +78935,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: false content: @@ -78951,12 +78996,12 @@ paths: application/json: schema: type: array - items: *533 + items: *537 examples: - default: *534 - '301': *334 + default: *538 + '301': *336 '404': *6 - '410': *523 + '410': *527 '422': *15 x-github: githubCloudOnly: false @@ -78973,9 +79018,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: false content: @@ -79035,12 +79080,12 @@ paths: application/json: schema: type: array - items: *533 + items: *537 examples: - default: *534 - '301': *334 + default: *538 + '301': *336 '404': *6 - '410': *523 + '410': *527 '422': *15 x-github: githubCloudOnly: false @@ -79057,15 +79102,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 responses: '204': description: Response - '301': *334 + '301': *336 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79084,9 +79129,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - name: name in: path required: true @@ -79099,7 +79144,7 @@ paths: application/json: schema: type: array - items: *533 + items: *537 examples: default: value: @@ -79110,9 +79155,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *334 + '301': *336 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79132,9 +79177,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: false content: @@ -79162,7 +79207,7 @@ paths: '204': description: Response '403': *29 - '410': *523 + '410': *527 '404': *6 '422': *15 x-github: @@ -79180,9 +79225,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 responses: '204': description: Response @@ -79212,20 +79257,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 responses: '200': description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 - '301': *334 + default: *533 + '301': *336 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79242,9 +79287,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - 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. @@ -79270,13 +79315,13 @@ paths: application/json: schema: type: array - items: *320 + items: *327 examples: - default: *322 + default: *329 headers: - Link: *54 + Link: *58 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79294,9 +79339,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: true content: @@ -79328,16 +79373,16 @@ paths: description: Response content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '201': description: Response content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '422': *15 x-github: githubCloudOnly: false @@ -79359,10 +79404,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *327 - - *328 - - *530 - - *323 + - *332 + - *333 + - *534 + - *330 responses: '204': description: Response @@ -79391,9 +79436,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: true content: @@ -79415,9 +79460,9 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 + default: *533 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -79450,9 +79495,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - *17 - *19 responses: @@ -79462,13 +79507,13 @@ paths: application/json: schema: type: array - items: *82 + items: *86 examples: - default: *532 + default: *536 headers: - Link: *54 + Link: *58 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79496,9 +79541,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: true content: @@ -79525,16 +79570,16 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 + default: *533 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *523 + '410': *527 '422': *15 '404': *6 x-github: @@ -79554,9 +79599,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 requestBody: required: true content: @@ -79587,13 +79632,13 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *529 + default: *533 '403': *29 '404': *6 '422': *7 - '503': *104 + '503': *110 x-github: triggersNotification: true githubCloudOnly: false @@ -79611,9 +79656,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *327 - - *328 - - *530 + - *332 + - *333 + - *534 - *17 - *19 responses: @@ -79628,10 +79673,6 @@ paths: description: Timeline Event type: object anyOf: - - *535 - - *536 - - *537 - - *538 - *539 - *540 - *541 @@ -79641,6 +79682,10 @@ paths: - *545 - *546 - *547 + - *548 + - *549 + - *550 + - *551 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -79683,7 +79728,7 @@ paths: issue_url: type: string format: uri - author_association: *69 + author_association: *73 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -79693,9 +79738,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 - reactions: *70 + properties: *71 + required: *72 + reactions: *74 required: - event - actor @@ -79726,7 +79771,7 @@ paths: properties: type: type: string - issue: *82 + issue: *86 required: - event - created_at @@ -79926,7 +79971,7 @@ paths: type: string body_text: type: string - author_association: *69 + author_association: *73 required: - event - id @@ -79949,7 +79994,7 @@ paths: type: string comments: type: array - items: &569 + items: &573 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -80038,7 +80083,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *69 + author_association: *73 _links: type: object properties: @@ -80122,7 +80167,7 @@ paths: enum: - line - file - reactions: *70 + reactions: *74 body_html: type: string example: '"

comment body

"' @@ -80158,7 +80203,7 @@ paths: type: string comments: type: array - items: *457 + items: *461 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -80189,8 +80234,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 assignee: *4 required: - id @@ -80233,8 +80278,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 assignee: *4 required: - id @@ -80277,8 +80322,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 state_reason: type: string nullable: true @@ -80445,9 +80490,9 @@ paths: type: User site_admin: true headers: - Link: *54 + Link: *58 '404': *6 - '410': *523 + '410': *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80464,8 +80509,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -80475,7 +80520,7 @@ paths: application/json: schema: type: array - items: &548 + items: &552 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -80525,7 +80570,7 @@ paths: last_used: '2022-01-10T15:53:42Z' enabled: true headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80541,8 +80586,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -80578,9 +80623,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *552 examples: - default: &549 + default: &553 value: id: 1 key: ssh-rsa AAA... @@ -80614,9 +80659,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *327 - - *328 - - &550 + - *332 + - *333 + - &554 name: key_id description: The unique identifier of the key. in: path @@ -80628,9 +80673,9 @@ paths: description: Response content: application/json: - schema: *548 + schema: *552 examples: - default: *549 + default: *553 '404': *6 x-github: githubCloudOnly: false @@ -80648,9 +80693,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *327 - - *328 - - *550 + - *332 + - *333 + - *554 responses: '204': description: Response @@ -80670,8 +80715,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -80681,11 +80726,11 @@ paths: application/json: schema: type: array - items: *533 + items: *537 examples: - default: *534 + default: *538 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -80704,8 +80749,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -80741,9 +80786,9 @@ paths: description: Response content: application/json: - schema: *533 + schema: *537 examples: - default: &551 + default: &555 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -80775,8 +80820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *327 - - *328 + - *332 + - *333 - name: name in: path required: true @@ -80787,9 +80832,9 @@ paths: description: Response content: application/json: - schema: *533 + schema: *537 examples: - default: *551 + default: *555 '404': *6 x-github: githubCloudOnly: false @@ -80806,8 +80851,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *327 - - *328 + - *332 + - *333 - name: name in: path required: true @@ -80846,7 +80891,7 @@ paths: description: Response content: application/json: - schema: *533 + schema: *537 examples: default: value: @@ -80872,8 +80917,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *327 - - *328 + - *332 + - *333 - name: name in: path required: true @@ -80899,8 +80944,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -80939,9 +80984,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *327 - - *328 - - *433 + - *332 + - *333 + - *437 responses: '200': description: Response @@ -81003,8 +81048,8 @@ paths: title: License Simple description: License Simple type: object - properties: *83 - required: *84 + properties: *87 + required: *88 nullable: true required: - _links @@ -81086,8 +81131,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -81152,8 +81197,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -81187,9 +81232,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *458 + schema: *462 examples: - default: *552 + default: *556 '204': description: Response when already merged '404': @@ -81214,8 +81259,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *327 - - *328 + - *332 + - *333 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -81256,12 +81301,12 @@ paths: application/json: schema: type: array - items: &553 + items: &557 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *256 - required: *257 + properties: *262 + required: *263 examples: default: value: @@ -81300,7 +81345,7 @@ paths: closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -81317,8 +81362,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -81358,9 +81403,9 @@ paths: description: Response content: application/json: - schema: *553 + schema: *557 examples: - default: &554 + default: &558 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -81419,9 +81464,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *327 - - *328 - - &555 + - *332 + - *333 + - &559 name: milestone_number description: The number that identifies the milestone. in: path @@ -81433,9 +81478,9 @@ paths: description: Response content: application/json: - schema: *553 + schema: *557 examples: - default: *554 + default: *558 '404': *6 x-github: githubCloudOnly: false @@ -81452,9 +81497,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *327 - - *328 - - *555 + - *332 + - *333 + - *559 requestBody: required: false content: @@ -81492,9 +81537,9 @@ paths: description: Response content: application/json: - schema: *553 + schema: *557 examples: - default: *554 + default: *558 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81510,9 +81555,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *327 - - *328 - - *555 + - *332 + - *333 + - *559 responses: '204': description: Response @@ -81533,9 +81578,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *327 - - *328 - - *555 + - *332 + - *333 + - *559 - *17 - *19 responses: @@ -81545,11 +81590,11 @@ paths: application/json: schema: type: array - items: *533 + items: *537 examples: - default: *534 + default: *538 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81566,12 +81611,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *327 - - *328 - - *556 - - *557 - - *72 - - *558 + - *332 + - *333 + - *560 + - *561 + - *76 + - *562 - *17 - *19 responses: @@ -81581,11 +81626,11 @@ paths: application/json: schema: type: array - items: *95 + items: *99 examples: - default: *559 + default: *563 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -81607,8 +81652,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: false content: @@ -81666,14 +81711,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: &560 + schema: &564 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -81798,7 +81843,7 @@ paths: - custom_404 - public examples: - default: &561 + default: &565 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -81839,8 +81884,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -81894,11 +81939,11 @@ paths: description: Response content: application/json: - schema: *560 + schema: *564 examples: - default: *561 + default: *565 '422': *15 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81919,8 +81964,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -81998,7 +82043,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82019,14 +82064,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response '422': *15 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82046,8 +82091,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -82057,7 +82102,7 @@ paths: application/json: schema: type: array - items: &562 + items: &566 title: Page Build description: Page Build type: object @@ -82132,7 +82177,7 @@ paths: created_at: '2014-02-10T19:00:49Z' updated_at: '2014-02-10T19:00:51Z' headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82151,8 +82196,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *327 - - *328 + - *332 + - *333 responses: '201': description: Response @@ -82197,16 +82242,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *562 + schema: *566 examples: - default: &563 + default: &567 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -82254,8 +82299,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *327 - - *328 + - *332 + - *333 - name: build_id in: path required: true @@ -82266,9 +82311,9 @@ paths: description: Response content: application/json: - schema: *562 + schema: *566 examples: - default: *563 + default: *567 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82288,8 +82333,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -82394,9 +82439,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *327 - - *328 - - &564 + - *332 + - *333 + - &568 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -82454,11 +82499,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *327 - - *328 - - *564 + - *332 + - *333 + - *568 responses: - '204': *175 + '204': *181 '404': *6 x-github: githubCloudOnly: false @@ -82483,8 +82528,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -82715,7 +82760,7 @@ paths: description: Empty response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -82742,8 +82787,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: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Private vulnerability reporting status @@ -82780,10 +82825,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: - '204': *175 + '204': *181 '422': *14 x-github: githubCloudOnly: false @@ -82802,10 +82847,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: - '204': *175 + '204': *181 '422': *14 x-github: githubCloudOnly: false @@ -82825,8 +82870,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -82834,9 +82879,9 @@ paths: application/json: schema: type: array - items: *102 + items: *108 examples: - default: *565 + default: *569 '403': *29 '404': *6 x-github: @@ -82858,8 +82903,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: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -82871,11 +82916,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *102 + items: *108 required: - properties examples: - default: *566 + default: *570 responses: '204': description: No Content when custom property values are successfully created @@ -82913,8 +82958,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *327 - - *328 + - *332 + - *333 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -82974,11 +83019,11 @@ paths: application/json: schema: type: array - items: *462 + items: *466 examples: - default: *567 + default: *571 headers: - Link: *54 + Link: *58 '304': *37 '422': *15 x-github: @@ -83008,8 +83053,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -83074,7 +83119,7 @@ paths: description: Response content: application/json: - schema: &571 + schema: &575 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -83185,8 +83230,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *256 - required: *257 + properties: *262 + required: *263 nullable: true active_lock_reason: type: string @@ -83231,7 +83276,7 @@ paths: nullable: true requested_teams: type: array - items: *305 + items: *312 nullable: true head: type: object @@ -83240,7 +83285,7 @@ paths: type: string ref: type: string - repo: *66 + repo: *70 sha: type: string user: *4 @@ -83257,7 +83302,7 @@ paths: type: string ref: type: string - repo: *66 + repo: *70 sha: type: string user: *4 @@ -83270,14 +83315,14 @@ paths: _links: type: object properties: - comments: *258 - commits: *258 - statuses: *258 - html: *258 - issue: *258 - review_comments: *258 - review_comment: *258 - self: *258 + comments: *264 + commits: *264 + statuses: *264 + html: *264 + issue: *264 + review_comments: *264 + review_comment: *264 + self: *264 required: - comments - commits @@ -83287,8 +83332,8 @@ paths: - review_comments - review_comment - self - author_association: *69 - auto_merge: *568 + author_association: *73 + auto_merge: *572 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -83380,7 +83425,7 @@ paths: - merged_by - review_comments examples: - default: &572 + default: &576 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -83907,8 +83952,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *327 - - *328 + - *332 + - *333 - name: sort in: query required: false @@ -83927,7 +83972,7 @@ paths: enum: - asc - desc - - *72 + - *76 - *17 - *19 responses: @@ -83937,9 +83982,9 @@ paths: application/json: schema: type: array - items: *569 + items: *573 examples: - default: &574 + default: &578 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -83991,7 +84036,7 @@ paths: original_line: 2 side: RIGHT headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84016,17 +84061,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 responses: '200': description: Response content: application/json: - schema: *569 + schema: *573 examples: - default: &570 + default: &574 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -84101,9 +84146,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 requestBody: required: true content: @@ -84125,9 +84170,9 @@ paths: description: Response content: application/json: - schema: *569 + schema: *573 examples: - default: *570 + default: *574 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84143,9 +84188,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 responses: '204': description: Response @@ -84166,9 +84211,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 - 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. @@ -84194,11 +84239,11 @@ paths: application/json: schema: type: array - items: *320 + items: *327 examples: - default: *322 + default: *329 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -84217,9 +84262,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *327 - - *328 - - *81 + - *332 + - *333 + - *85 requestBody: required: true content: @@ -84251,16 +84296,16 @@ paths: description: Reaction exists content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '201': description: Reaction created content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '422': *15 x-github: githubCloudOnly: false @@ -84282,10 +84327,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *327 - - *328 - - *81 - - *323 + - *332 + - *333 + - *85 + - *330 responses: '204': description: Response @@ -84328,9 +84373,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *327 - - *328 - - &573 + - *332 + - *333 + - &577 name: pull_number description: The number that identifies the pull request. in: path @@ -84343,9 +84388,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *571 + schema: *575 examples: - default: *572 + default: *576 '304': *37 '404': *6 '406': @@ -84353,8 +84398,8 @@ paths: content: application/json: schema: *3 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84380,9 +84425,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 requestBody: required: false content: @@ -84424,9 +84469,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *575 examples: - default: *572 + default: *576 '422': *15 '403': *29 x-github: @@ -84448,9 +84493,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 requestBody: required: true content: @@ -84510,21 +84555,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *224 + schema: *230 examples: - default: *447 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *224 + schema: *230 examples: - default: *447 + default: *451 '401': *25 '403': *29 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -84550,10 +84595,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *327 - - *328 - - *573 - - *92 + - *332 + - *333 + - *577 + - *96 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -84563,7 +84608,7 @@ paths: enum: - asc - desc - - *72 + - *76 - *17 - *19 responses: @@ -84573,11 +84618,11 @@ paths: application/json: schema: type: array - items: *569 + items: *573 examples: - default: *574 + default: *578 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84608,9 +84653,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 requestBody: required: true content: @@ -84715,7 +84760,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *573 examples: example-for-a-multi-line-comment: value: @@ -84803,10 +84848,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *327 - - *328 - - *573 - - *81 + - *332 + - *333 + - *577 + - *85 requestBody: required: true content: @@ -84828,7 +84873,7 @@ paths: description: Response content: application/json: - schema: *569 + schema: *573 examples: default: value: @@ -84914,9 +84959,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 - *17 - *19 responses: @@ -84926,11 +84971,11 @@ paths: application/json: schema: type: array - items: *458 + items: *462 examples: - default: *575 + default: *579 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84958,9 +85003,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 - *17 - *19 responses: @@ -84970,7 +85015,7 @@ paths: application/json: schema: type: array - items: *471 + items: *475 examples: default: value: @@ -84986,10 +85031,10 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" headers: - Link: *54 + Link: *58 '422': *15 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85008,9 +85053,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 responses: '204': description: Response if pull request has been merged @@ -85033,9 +85078,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 requestBody: required: false content: @@ -85146,9 +85191,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 responses: '200': description: Response @@ -85164,7 +85209,7 @@ paths: items: *4 teams: type: array - items: *181 + items: *187 required: - users - teams @@ -85205,7 +85250,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85223,9 +85268,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 requestBody: required: false content: @@ -85262,7 +85307,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *466 examples: default: value: @@ -85798,9 +85843,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 requestBody: required: true content: @@ -85834,7 +85879,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *466 examples: default: value: @@ -86339,9 +86384,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 - *17 - *19 responses: @@ -86351,7 +86396,7 @@ paths: application/json: schema: type: array - items: &576 + items: &580 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -86420,7 +86465,7 @@ paths: type: string body_text: type: string - author_association: *69 + author_association: *73 required: - id - node_id @@ -86469,7 +86514,7 @@ paths: commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 author_association: COLLABORATOR headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86502,9 +86547,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 requestBody: required: false content: @@ -86590,9 +86635,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: &578 + default: &582 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -86655,10 +86700,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 - - &577 + - *332 + - *333 + - *577 + - &581 name: review_id description: The unique identifier of the review. in: path @@ -86670,9 +86715,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: &579 + default: &583 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -86731,10 +86776,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 - *577 + - *581 requestBody: required: true content: @@ -86757,7 +86802,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: default: value: @@ -86819,18 +86864,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 - *577 + - *581 responses: '200': description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: *578 + default: *582 '422': *7 '404': *6 x-github: @@ -86857,10 +86902,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *327 - - *328 - - *573 + - *332 + - *333 - *577 + - *581 - *17 - *19 responses: @@ -86939,13 +86984,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *69 + author_association: *73 _links: type: object properties: - self: *258 - html: *258 - pull_request: *258 + self: *264 + html: *264 + pull_request: *264 required: - self - html @@ -86954,7 +86999,7 @@ paths: type: string body_html: type: string - reactions: *70 + reactions: *74 side: description: The side of the first line of the range for a multi-line comment. @@ -87066,7 +87111,7 @@ paths: pull_request: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -87095,10 +87140,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 - *577 + - *581 requestBody: required: true content: @@ -87126,7 +87171,7 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: default: value: @@ -87189,10 +87234,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *327 - - *328 - - *573 + - *332 + - *333 - *577 + - *581 requestBody: required: true content: @@ -87227,9 +87272,9 @@ paths: description: Response content: application/json: - schema: *576 + schema: *580 examples: - default: *579 + default: *583 '404': *6 '422': *7 '403': *29 @@ -87251,9 +87296,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *327 - - *328 - - *573 + - *332 + - *333 + - *577 requestBody: required: false content: @@ -87316,8 +87361,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *327 - - *328 + - *332 + - *333 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -87330,9 +87375,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *584 examples: - default: &581 + default: &585 value: type: file encoding: base64 @@ -87374,8 +87419,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *327 - - *328 + - *332 + - *333 - name: dir description: The alternate path to look for a README file in: path @@ -87395,9 +87440,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *584 examples: - default: *581 + default: *585 '404': *6 '422': *15 x-github: @@ -87419,8 +87464,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -87430,7 +87475,7 @@ paths: application/json: schema: type: array - items: &582 + items: &586 title: Release description: A release. type: object @@ -87501,7 +87546,7 @@ paths: author: *4 assets: type: array - items: &583 + items: &587 title: Release Asset description: Data related to a release. type: object @@ -87576,7 +87621,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *70 + reactions: *74 required: - assets_url - upload_url @@ -87668,7 +87713,7 @@ paths: type: User site_admin: false headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -87688,8 +87733,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -87765,9 +87810,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: &586 + default: &590 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -87872,9 +87917,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *327 - - *328 - - &584 + - *332 + - *333 + - &588 name: asset_id description: The unique identifier of the asset. in: path @@ -87886,9 +87931,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *587 examples: - default: &585 + default: &589 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 @@ -87923,7 +87968,7 @@ paths: type: User site_admin: false '404': *6 - '302': *473 + '302': *477 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87939,9 +87984,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *327 - - *328 - - *584 + - *332 + - *333 + - *588 requestBody: required: false content: @@ -87969,9 +88014,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *587 examples: - default: *585 + default: *589 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87987,9 +88032,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *327 - - *328 - - *584 + - *332 + - *333 + - *588 responses: '204': description: Response @@ -88013,8 +88058,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -88099,16 +88144,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88125,8 +88170,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *327 - - *328 + - *332 + - *333 - name: tag description: tag parameter in: path @@ -88139,9 +88184,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 '404': *6 x-github: githubCloudOnly: false @@ -88163,9 +88208,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *327 - - *328 - - &587 + - *332 + - *333 + - &591 name: release_id description: The unique identifier of the release. in: path @@ -88179,9 +88224,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 '401': description: Unauthorized x-github: @@ -88199,9 +88244,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *327 - - *328 - - *587 + - *332 + - *333 + - *591 requestBody: required: false content: @@ -88265,9 +88310,9 @@ paths: description: Response content: application/json: - schema: *582 + schema: *586 examples: - default: *586 + default: *590 '404': description: Not Found if the discussion category name is invalid content: @@ -88288,9 +88333,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *327 - - *328 - - *587 + - *332 + - *333 + - *591 responses: '204': description: Response @@ -88310,9 +88355,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *327 - - *328 - - *587 + - *332 + - *333 + - *591 - *17 - *19 responses: @@ -88322,7 +88367,7 @@ paths: application/json: schema: type: array - items: *583 + items: *587 examples: default: value: @@ -88359,7 +88404,7 @@ paths: type: User site_admin: false headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88403,9 +88448,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: - - *327 - - *328 - - *587 + - *332 + - *333 + - *591 - name: name in: query required: true @@ -88431,7 +88476,7 @@ paths: description: Response for successful upload content: application/json: - schema: *583 + schema: *587 examples: response-for-successful-upload: value: @@ -88486,9 +88531,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *327 - - *328 - - *587 + - *332 + - *333 + - *591 - 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. @@ -88512,11 +88557,11 @@ paths: application/json: schema: type: array - items: *320 + items: *327 examples: - default: *322 + default: *329 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -88535,9 +88580,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *327 - - *328 - - *587 + - *332 + - *333 + - *591 requestBody: required: true content: @@ -88567,16 +88612,16 @@ paths: description: Reaction exists content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '201': description: Reaction created content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '422': *15 x-github: githubCloudOnly: false @@ -88598,10 +88643,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *327 - - *328 - - *587 - - *323 + - *332 + - *333 + - *591 + - *330 responses: '204': description: Response @@ -88625,9 +88670,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *327 - - *328 - - *395 + - *332 + - *333 + - *399 - *17 - *19 responses: @@ -88643,8 +88688,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *278 - - &588 + - *284 + - &592 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -88663,69 +88708,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *279 - - *588 - - allOf: - - *280 - - *588 - - allOf: - - *281 - - *588 - - allOf: - - *589 - - *588 - - allOf: - - *282 - - *588 - - allOf: - - *283 - - *588 - - allOf: - - *284 - - *588 - allOf: - *285 - - *588 + - *592 - allOf: - *286 - - *588 + - *592 - allOf: - *287 - - *588 + - *592 + - allOf: + - *593 + - *592 - allOf: - *288 - - *588 + - *592 - allOf: - *289 - - *588 + - *592 - allOf: - *290 - - *588 + - *592 - allOf: - *291 - - *588 + - *592 - allOf: - *292 - - *588 + - *592 - allOf: - *293 - - *588 + - *592 - allOf: - *294 - - *588 + - *592 - allOf: - *295 - - *588 + - *592 - allOf: - *296 - - *588 + - *592 - allOf: - *297 - - *588 + - *592 + - allOf: + - *298 + - *592 - allOf: - - *590 - - *588 + - *299 + - *592 + - allOf: + - *300 + - *592 + - allOf: + - *301 + - *592 + - allOf: + - *302 + - *592 + - allOf: + - *303 + - *592 + - allOf: + - *304 + - *592 examples: default: value: @@ -88764,8 +88809,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 - name: includes_parents @@ -88776,7 +88821,7 @@ paths: schema: type: boolean default: true - - *591 + - *594 responses: '200': description: Response @@ -88784,7 +88829,7 @@ paths: application/json: schema: type: array - items: *298 + items: *305 examples: default: value: @@ -88815,7 +88860,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *103 + '500': *109 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -88831,8 +88876,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *332 + - *333 requestBody: description: Request body required: true @@ -88852,16 +88897,16 @@ paths: - tag - push default: branch - enforcement: *275 + enforcement: *281 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *276 - conditions: *273 + items: *282 + conditions: *279 rules: type: array description: An array of rules within the ruleset. - items: *592 + items: *595 required: - name - enforcement @@ -88892,9 +88937,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: &602 + default: &605 value: id: 42 name: super cool ruleset @@ -88927,7 +88972,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *6 - '500': *103 + '500': *109 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -88941,12 +88986,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *327 - - *328 - - *593 - - *594 - - *595 + - *332 + - *333 - *596 + - *597 + - *598 + - *599 - *17 - *19 responses: @@ -88954,11 +88999,11 @@ paths: description: Response content: application/json: - schema: *597 + schema: *600 examples: - default: *598 + default: *601 '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88977,19 +89022,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *327 - - *328 - - *599 + - *332 + - *333 + - *602 responses: '200': description: Response content: application/json: - schema: *600 + schema: *603 examples: - default: *601 + default: *604 '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89015,8 +89060,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *332 + - *333 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89036,11 +89081,11 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *602 + default: *605 '404': *6 - '500': *103 + '500': *109 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -89056,8 +89101,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *332 + - *333 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89082,16 +89127,16 @@ paths: - branch - tag - push - enforcement: *275 + enforcement: *281 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *276 - conditions: *273 + items: *282 + conditions: *279 rules: description: An array of rules within the ruleset. type: array - items: *592 + items: *595 examples: default: value: @@ -89119,11 +89164,11 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *602 + default: *605 '404': *6 - '500': *103 + '500': *109 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -89139,8 +89184,8 @@ paths: category: repos subcategory: rules parameters: - - *327 - - *328 + - *332 + - *333 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89151,7 +89196,7 @@ paths: '204': description: Response '404': *6 - '500': *103 + '500': *109 "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": get: summary: Get repository ruleset history @@ -89163,8 +89208,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 - name: ruleset_id @@ -89180,11 +89225,11 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *603 + default: *606 '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89201,8 +89246,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *327 - - *328 + - *332 + - *333 - name: ruleset_id description: The ID of the ruleset. in: path @@ -89220,7 +89265,7 @@ paths: description: Response content: application/json: - schema: *604 + schema: *607 examples: default: value: @@ -89253,7 +89298,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89275,21 +89320,22 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *327 - - *328 - - *605 - - *606 - - *607 + - *332 + - *333 - *608 - - *48 - - *19 - - *17 - *609 - *610 - *611 - *612 + - *52 + - *19 + - *17 - *613 - *614 + - *615 + - *616 + - *617 + - *618 responses: '200': description: Response @@ -89297,11 +89343,11 @@ paths: application/json: schema: type: array - items: &618 + items: &622 type: object properties: - number: *161 - created_at: *162 + number: *167 + created_at: *168 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -89309,15 +89355,15 @@ paths: format: date-time readOnly: true nullable: true - url: *164 - html_url: *165 + url: *170 + html_url: *171 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *615 - resolution: *616 + state: *619 + resolution: *620 resolved_at: type: string format: date-time @@ -89413,7 +89459,7 @@ paths: pull request. ' - oneOf: *617 + oneOf: *621 nullable: true has_more_locations: type: boolean @@ -89540,7 +89586,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89562,16 +89608,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *327 - - *328 - - *427 - - *614 + - *332 + - *333 + - *431 + - *618 responses: '200': description: Response content: application/json: - schema: *618 + schema: *622 examples: default: value: @@ -89602,7 +89648,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89613,6 +89659,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. @@ -89623,9 +89671,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *327 - - *328 - - *427 + - *332 + - *333 + - *431 requestBody: required: true content: @@ -89633,27 +89681,42 @@ paths: schema: type: object properties: - state: *615 - resolution: *616 + state: *619 + resolution: *620 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true + assignee: + description: The username of the user to assign to the alert. Set + to `null` to unassign the alert. + type: string + nullable: true 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: *618 + schema: *622 examples: default: value: @@ -89698,6 +89761,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. @@ -89705,8 +89787,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': *104 + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository + '503': *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -89728,9 +89811,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *327 - - *328 - - *427 + - *332 + - *333 + - *431 - *19 - *17 responses: @@ -89741,7 +89824,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &770 + items: &781 type: object properties: type: @@ -89767,10 +89850,6 @@ paths: example: commit details: oneOf: - - *619 - - *620 - - *621 - - *622 - *623 - *624 - *625 @@ -89780,6 +89859,10 @@ paths: - *629 - *630 - *631 + - *632 + - *633 + - *634 + - *635 examples: default: value: @@ -89839,11 +89922,11 @@ paths: details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 headers: - Link: *54 + Link: *58 '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89865,8 +89948,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -89874,14 +89957,14 @@ paths: schema: type: object properties: - reason: &633 + reason: &637 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *632 + placeholder_id: *636 required: - reason - placeholder_id @@ -89898,7 +89981,7 @@ paths: schema: type: object properties: - reason: *633 + reason: *637 expire_at: type: string format: date-time @@ -89921,7 +90004,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *104 + '503': *110 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -89944,13 +90027,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: - - *327 - - *328 + - *332 + - *333 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *104 + '503': *110 '200': description: Response content: @@ -89960,7 +90043,7 @@ paths: properties: incremental_scans: type: array - items: &634 + items: &638 description: Information on a single scan performed by secret scanning on the repository type: object @@ -89986,15 +90069,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *634 + items: *638 backfill_scans: type: array - items: *634 + items: *638 custom_pattern_backfill_scans: type: array items: allOf: - - *634 + - *638 - type: object properties: pattern_name: @@ -90064,9 +90147,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *327 - - *328 - - *48 + - *332 + - *333 + - *52 - name: sort description: The property to sort the results by. in: query @@ -90078,8 +90161,8 @@ paths: - updated - published default: created - - *40 - - *41 + - *45 + - *46 - 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)." @@ -90109,9 +90192,9 @@ paths: application/json: schema: type: array - items: *635 + items: *639 examples: - default: *636 + default: *640 '400': *14 '404': *6 x-github: @@ -90134,8 +90217,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -90208,7 +90291,7 @@ paths: login: type: string description: The username of the user credited. - type: *304 + type: *311 required: - login - type @@ -90295,9 +90378,9 @@ paths: description: Response content: application/json: - schema: *635 + schema: *639 examples: - default: &638 + default: &642 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -90530,8 +90613,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -90635,7 +90718,7 @@ paths: description: Response content: application/json: - schema: *635 + schema: *639 examples: default: value: @@ -90782,17 +90865,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *327 - - *328 - - *637 + - *332 + - *333 + - *641 responses: '200': description: Response content: application/json: - schema: *635 + schema: *639 examples: - default: *638 + default: *642 '403': *29 '404': *6 x-github: @@ -90816,9 +90899,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *327 - - *328 - - *637 + - *332 + - *333 + - *641 requestBody: required: true content: @@ -90891,7 +90974,7 @@ paths: login: type: string description: The username of the user credited. - type: *304 + type: *311 required: - login - type @@ -90977,17 +91060,17 @@ paths: description: Response content: application/json: - schema: *635 + schema: *639 examples: - default: *638 - add_credit: *638 + default: *642 + add_credit: *642 '403': *29 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *112 + schema: *118 examples: invalid_state_transition: value: @@ -91018,9 +91101,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: - - *327 - - *328 - - *637 + - *332 + - *333 + - *641 responses: '202': *39 '400': *14 @@ -91047,17 +91130,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *327 - - *328 - - *637 + - *332 + - *333 + - *641 responses: '202': description: Response content: application/json: - schema: *333 + schema: *335 examples: - default: *335 + default: *337 '400': *14 '422': *15 '403': *29 @@ -91083,8 +91166,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -91161,7 +91244,7 @@ paths: type: User site_admin: false headers: - Link: *54 + Link: *58 '422': *15 x-github: githubCloudOnly: false @@ -91183,8 +91266,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -91193,7 +91276,7 @@ paths: application/json: schema: type: array - items: &639 + items: &643 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -91206,7 +91289,7 @@ paths: - 1124 - -435 '202': *39 - '204': *175 + '204': *181 '422': description: Repository contains more than 10,000 commits x-github: @@ -91226,8 +91309,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -91276,7 +91359,7 @@ paths: total: 89 week: 1336280400 '202': *39 - '204': *175 + '204': *181 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91303,8 +91386,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -91378,7 +91461,7 @@ paths: d: 77 c: 10 '202': *39 - '204': *175 + '204': *181 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91400,8 +91483,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -91555,8 +91638,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -91566,7 +91649,7 @@ paths: application/json: schema: type: array - items: *639 + items: *643 examples: default: value: @@ -91579,7 +91662,7 @@ paths: - - 0 - 2 - 21 - '204': *175 + '204': *181 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91599,8 +91682,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *327 - - *328 + - *332 + - *333 - name: sha in: path required: true @@ -91654,7 +91737,7 @@ paths: description: Response content: application/json: - schema: *640 + schema: *644 examples: default: value: @@ -91708,8 +91791,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -91721,9 +91804,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91741,14 +91824,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &641 + schema: &645 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -91816,8 +91899,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: false content: @@ -91843,7 +91926,7 @@ paths: description: Response content: application/json: - schema: *641 + schema: *645 examples: default: value: @@ -91870,8 +91953,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -91891,8 +91974,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -91948,7 +92031,7 @@ paths: tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91971,8 +92054,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -91980,7 +92063,7 @@ paths: application/json: schema: type: array - items: &642 + items: &646 title: Tag protection description: Tag protection type: object @@ -92032,8 +92115,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: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -92056,7 +92139,7 @@ paths: description: Response content: application/json: - schema: *642 + schema: *646 examples: default: value: @@ -92087,8 +92170,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: - - *327 - - *328 + - *332 + - *333 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -92125,8 +92208,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *327 - - *328 + - *332 + - *333 - name: ref in: path required: true @@ -92162,8 +92245,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *327 - - *328 + - *332 + - *333 - *17 - *19 responses: @@ -92173,11 +92256,11 @@ paths: application/json: schema: type: array - items: *181 + items: *187 examples: - default: *236 + default: *242 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -92195,8 +92278,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *327 - - *328 + - *332 + - *333 - *19 - *17 responses: @@ -92204,7 +92287,7 @@ paths: description: Response content: application/json: - schema: &643 + schema: &647 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -92216,7 +92299,7 @@ paths: required: - names examples: - default: &644 + default: &648 value: names: - octocat @@ -92239,8 +92322,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -92271,9 +92354,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *647 examples: - default: *644 + default: *648 '404': *6 '422': *7 x-github: @@ -92294,9 +92377,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *327 - - *328 - - &645 + - *332 + - *333 + - &649 name: per description: The time frame to display results for. in: query @@ -92325,7 +92408,7 @@ paths: example: 128 clones: type: array - items: &646 + items: &650 title: Traffic type: object properties: @@ -92412,8 +92495,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -92503,8 +92586,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *327 - - *328 + - *332 + - *333 responses: '200': description: Response @@ -92564,9 +92647,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *327 - - *328 - - *645 + - *332 + - *333 + - *649 responses: '200': description: Response @@ -92585,7 +92668,7 @@ paths: example: 3782 views: type: array - items: *646 + items: *650 required: - uniques - count @@ -92662,8 +92745,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *327 - - *328 + - *332 + - *333 requestBody: required: true content: @@ -92699,7 +92782,7 @@ paths: description: Response content: application/json: - schema: *143 + schema: *149 examples: default: value: @@ -92937,8 +93020,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -92961,8 +93044,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -92984,8 +93067,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -93011,8 +93094,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *327 - - *328 + - *332 + - *333 - name: ref in: path required: true @@ -93104,9 +93187,9 @@ paths: description: Response content: application/json: - schema: *333 + schema: *335 examples: - default: *335 + default: *337 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -93147,7 +93230,7 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: default: value: @@ -93336,7 +93419,7 @@ paths: html_url: type: string format: uri - repository: *143 + repository: *149 score: type: number file_size: @@ -93354,7 +93437,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &647 + text_matches: &651 title: Search Result Text Matches type: array items: @@ -93468,7 +93551,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *104 + '503': *110 '422': *15 '403': *29 x-github: @@ -93516,7 +93599,7 @@ paths: enum: - author-date - committer-date - - &648 + - &652 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 @@ -93587,7 +93670,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *393 + properties: *397 nullable: true comment_count: type: integer @@ -93607,7 +93690,7 @@ paths: url: type: string format: uri - verification: *509 + verification: *513 required: - author - committer @@ -93626,7 +93709,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *393 + properties: *397 nullable: true parents: type: array @@ -93639,12 +93722,12 @@ paths: type: string sha: type: string - repository: *143 + repository: *149 score: type: number node_id: type: string - text_matches: *647 + text_matches: *651 required: - sha - node_id @@ -93836,7 +93919,7 @@ paths: - interactions - created - updated - - *648 + - *652 - *17 - *19 - name: advanced_search @@ -93933,11 +94016,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: type: string state_reason: @@ -93954,8 +94037,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *256 - required: *257 + properties: *262 + required: *263 nullable: true comments: type: integer @@ -93969,7 +94052,7 @@ paths: type: string format: date-time nullable: true - text_matches: *647 + text_matches: *651 pull_request: type: object properties: @@ -94002,10 +94085,10 @@ paths: type: string score: type: number - author_association: *69 + author_association: *73 draft: type: boolean - repository: *66 + repository: *70 body_html: type: string body_text: @@ -94013,7 +94096,7 @@ paths: timeline_url: type: string format: uri - type: *219 + type: *225 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -94023,9 +94106,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 - reactions: *70 + properties: *71 + required: *72 + reactions: *74 required: - assignee - closed_at @@ -94141,7 +94224,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *104 + '503': *110 '422': *15 '304': *37 '403': *29 @@ -94194,7 +94277,7 @@ paths: enum: - created - updated - - *648 + - *652 - *17 - *19 responses: @@ -94238,7 +94321,7 @@ paths: nullable: true score: type: number - text_matches: *647 + text_matches: *651 required: - id - node_id @@ -94323,7 +94406,7 @@ paths: - forks - help-wanted-issues - updated - - *648 + - *652 - *17 - *19 responses: @@ -94542,8 +94625,8 @@ paths: title: License Simple description: License Simple type: object - properties: *83 - required: *84 + properties: *87 + required: *88 nullable: true permissions: type: object @@ -94562,7 +94645,7 @@ paths: - admin - pull - push - text_matches: *647 + text_matches: *651 temp_clone_token: type: string allow_merge_commit: @@ -94764,7 +94847,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *104 + '503': *110 '422': *15 '304': *37 x-github: @@ -94862,7 +94945,7 @@ paths: type: string format: uri nullable: true - text_matches: *647 + text_matches: *651 related: type: array nullable: true @@ -95053,7 +95136,7 @@ paths: - followers - repositories - joined - - *648 + - *652 - *17 - *19 responses: @@ -95157,7 +95240,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *647 + text_matches: *651 blog: type: string nullable: true @@ -95216,7 +95299,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *104 + '503': *110 '422': *15 x-github: githubCloudOnly: false @@ -95236,7 +95319,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &652 + - &656 name: team_id description: The unique identifier of the team. in: path @@ -95248,9 +95331,9 @@ paths: description: Response content: application/json: - schema: *312 + schema: *319 examples: - default: *313 + default: *320 '404': *6 x-github: githubCloudOnly: false @@ -95277,7 +95360,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *652 + - *656 requestBody: required: true content: @@ -95340,16 +95423,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *312 + schema: *319 examples: - default: *313 + default: *320 '201': description: Response content: application/json: - schema: *312 + schema: *319 examples: - default: *313 + default: *320 '404': *6 '422': *15 '403': *29 @@ -95377,7 +95460,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *652 + - *656 responses: '204': description: Response @@ -95408,8 +95491,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *652 - - *48 + - *656 + - *52 - *17 - *19 responses: @@ -95419,11 +95502,11 @@ paths: application/json: schema: type: array - items: *314 + items: *321 examples: - default: *653 + default: *657 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95450,7 +95533,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *652 + - *656 requestBody: required: true content: @@ -95484,9 +95567,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 x-github: triggersNotification: true githubCloudOnly: false @@ -95513,16 +95596,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *652 - - *316 + - *656 + - *323 responses: '200': description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95547,8 +95630,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *652 - - *316 + - *656 + - *323 requestBody: required: false content: @@ -95571,9 +95654,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *654 + default: *658 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95598,8 +95681,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *652 - - *316 + - *656 + - *323 responses: '204': description: Response @@ -95628,9 +95711,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *652 - - *316 - - *48 + - *656 + - *323 + - *52 - *17 - *19 responses: @@ -95640,11 +95723,11 @@ paths: application/json: schema: type: array - items: *317 + items: *324 examples: - default: *655 + default: *659 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95671,8 +95754,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *652 - - *316 + - *656 + - *323 requestBody: required: true content: @@ -95694,9 +95777,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *324 examples: - default: *318 + default: *325 x-github: triggersNotification: true githubCloudOnly: false @@ -95723,17 +95806,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *652 - - *316 - - *319 + - *656 + - *323 + - *326 responses: '200': description: Response content: application/json: - schema: *317 + schema: *324 examples: - default: *318 + default: *325 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95758,9 +95841,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *652 - - *316 - - *319 + - *656 + - *323 + - *326 requestBody: required: true content: @@ -95782,9 +95865,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *324 examples: - default: *656 + default: *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95809,9 +95892,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *652 - - *316 - - *319 + - *656 + - *323 + - *326 responses: '204': description: Response @@ -95840,9 +95923,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *652 - - *316 - - *319 + - *656 + - *323 + - *326 - 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. @@ -95868,11 +95951,11 @@ paths: application/json: schema: type: array - items: *320 + items: *327 examples: - default: *322 + default: *329 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95899,9 +95982,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *652 - - *316 - - *319 + - *656 + - *323 + - *326 requestBody: required: true content: @@ -95933,9 +96016,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95961,8 +96044,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *652 - - *316 + - *656 + - *323 - 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. @@ -95988,11 +96071,11 @@ paths: application/json: schema: type: array - items: *320 + items: *327 examples: - default: *322 + default: *329 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96019,8 +96102,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *652 - - *316 + - *656 + - *323 requestBody: required: true content: @@ -96052,9 +96135,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96078,7 +96161,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *652 + - *656 - *17 - *19 responses: @@ -96088,11 +96171,11 @@ paths: application/json: schema: type: array - items: *216 + items: *222 examples: - default: *217 + default: *223 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96116,7 +96199,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *652 + - *656 - name: role description: Filters members returned by their role in the team. in: query @@ -96139,9 +96222,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -96167,8 +96250,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *652 - - *59 + - *656 + - *63 responses: '204': description: if user is a member @@ -96204,8 +96287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *652 - - *59 + - *656 + - *63 responses: '204': description: Response @@ -96244,8 +96327,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *652 - - *59 + - *656 + - *63 responses: '204': description: Response @@ -96281,16 +96364,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *652 - - *59 + - *656 + - *63 responses: '200': description: Response content: application/json: - schema: *324 + schema: *331 examples: - response-if-user-is-a-team-maintainer: *657 + response-if-user-is-a-team-maintainer: *661 '404': *6 x-github: githubCloudOnly: false @@ -96323,8 +96406,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *652 - - *59 + - *656 + - *63 requestBody: required: false content: @@ -96349,9 +96432,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *331 examples: - response-if-users-membership-with-team-is-now-pending: *658 + response-if-users-membership-with-team-is-now-pending: *662 '403': description: Forbidden if team synchronization is set up '422': @@ -96385,8 +96468,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *652 - - *59 + - *656 + - *63 responses: '204': description: Response @@ -96400,174 +96483,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: - - *652 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *325 - examples: - default: *659 - headers: - Link: *54 - '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: - - *652 - - *326 - responses: - '200': - description: Response - content: - application/json: - schema: *325 - examples: - default: *660 - '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: - - *652 - - *326 - 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: - - *652 - - *326 - 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) @@ -96581,7 +96496,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *652 + - *656 - *17 - *19 responses: @@ -96591,11 +96506,11 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: *243 + default: *249 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -96623,15 +96538,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *652 - - *327 - - *328 + - *656 + - *332 + - *333 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *661 + schema: *663 examples: alternative-response-with-extra-repository-information: value: @@ -96782,9 +96697,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *652 - - *327 - - *328 + - *656 + - *332 + - *333 requestBody: required: false content: @@ -96834,9 +96749,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *652 - - *327 - - *328 + - *656 + - *332 + - *333 responses: '204': description: Response @@ -96861,7 +96776,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *652 + - *656 - *17 - *19 responses: @@ -96871,11 +96786,11 @@ paths: application/json: schema: type: array - items: *181 + items: *187 examples: - response-if-child-teams-exist: *662 + response-if-child-teams-exist: *664 headers: - Link: *54 + Link: *58 '404': *6 '403': *29 '422': *15 @@ -96906,7 +96821,7 @@ paths: application/json: schema: oneOf: - - &664 + - &666 title: Private User description: Private User type: object @@ -97109,7 +97024,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *663 + - *665 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -97262,7 +97177,7 @@ paths: description: Response content: application/json: - schema: *664 + schema: *666 examples: default: value: @@ -97341,7 +97256,7 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 '304': *37 '404': *6 '403': *29 @@ -97364,7 +97279,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: - - *59 + - *63 responses: '204': description: If the user is blocked @@ -97392,7 +97307,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *59 + - *63 responses: '204': description: Response @@ -97416,7 +97331,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *59 + - *63 responses: '204': description: Response @@ -97465,11 +97380,11 @@ paths: type: integer codespaces: type: array - items: *224 + items: *230 examples: - default: *225 + default: *231 '304': *37 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -97606,21 +97521,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *224 + schema: *230 examples: - default: *447 + default: *451 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *224 + schema: *230 examples: - default: *447 + default: *451 '401': *25 '403': *29 '404': *6 - '503': *104 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97660,7 +97575,7 @@ paths: type: integer secrets: type: array - items: &665 + items: &667 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -97700,9 +97615,9 @@ paths: - visibility - selected_repositories_url examples: - default: *450 + default: *454 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97770,13 +97685,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *151 + - *157 responses: '200': description: Response content: application/json: - schema: *665 + schema: *667 examples: default: value: @@ -97806,7 +97721,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *151 + - *157 requestBody: required: true content: @@ -97851,7 +97766,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -97879,7 +97794,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *151 + - *157 responses: '204': description: Response @@ -97904,7 +97819,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *151 + - *157 responses: '200': description: Response @@ -97920,13 +97835,13 @@ paths: type: integer repositories: type: array - items: *143 + items: *149 examples: - default: *666 + default: *668 '401': *25 '403': *29 '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97947,7 +97862,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *151 + - *157 requestBody: required: true content: @@ -97979,7 +97894,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98001,7 +97916,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *151 + - *157 - name: repository_id in: path required: true @@ -98013,7 +97928,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98034,7 +97949,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *151 + - *157 - name: repository_id in: path required: true @@ -98046,7 +97961,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *103 + '500': *109 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98066,17 +97981,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *226 + - *232 responses: '200': description: Response content: application/json: - schema: *224 + schema: *230 examples: - default: *447 + default: *451 '304': *37 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -98100,7 +98015,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *226 + - *232 requestBody: required: false content: @@ -98130,9 +98045,9 @@ paths: description: Response content: application/json: - schema: *224 + schema: *230 examples: - default: *447 + default: *451 '401': *25 '403': *29 '404': *6 @@ -98154,11 +98069,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *226 + - *232 responses: '202': *39 '304': *37 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -98183,13 +98098,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *226 + - *232 responses: '202': description: Response content: application/json: - schema: &667 + schema: &669 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -98230,7 +98145,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &668 + default: &670 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -98238,7 +98153,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -98262,7 +98177,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *226 + - *232 - name: export_id in: path required: true @@ -98275,9 +98190,9 @@ paths: description: Response content: application/json: - schema: *667 + schema: *669 examples: - default: *668 + default: *670 '404': *6 x-github: githubCloudOnly: false @@ -98298,7 +98213,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *226 + - *232 responses: '200': description: Response @@ -98314,11 +98229,11 @@ paths: type: integer machines: type: array - items: *669 + items: *671 examples: - default: *670 + default: *672 '304': *37 - '500': *103 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -98345,7 +98260,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *226 + - *232 requestBody: required: true content: @@ -98395,13 +98310,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *333 + repository: *335 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *448 - required: *449 + properties: *452 + required: *453 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -99175,17 +99090,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *226 + - *232 responses: '200': description: Response content: application/json: - schema: *224 + schema: *230 examples: - default: *447 + default: *451 '304': *37 - '500': *103 + '500': *109 '400': *14 '401': *25 '402': @@ -99195,7 +99110,7 @@ paths: schema: *3 '403': *29 '404': *6 - '409': *47 + '409': *51 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99215,16 +99130,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *226 + - *232 responses: '200': description: Response content: application/json: - schema: *224 + schema: *230 examples: - default: *447 - '500': *103 + default: *451 + '500': *109 '401': *25 '403': *29 '404': *6 @@ -99253,9 +99168,9 @@ paths: application/json: schema: type: array - items: *237 + items: *243 examples: - default: &681 + default: &683 value: - id: 197 name: hello_docker @@ -99356,7 +99271,7 @@ paths: application/json: schema: type: array - items: &671 + items: &673 title: Email description: Email type: object @@ -99421,16 +99336,16 @@ paths: application/json: schema: type: array - items: *671 + items: *673 examples: - default: &683 + default: &685 value: - email: octocat@github.com verified: true primary: true visibility: public headers: - Link: *54 + Link: *58 '304': *37 '404': *6 '403': *29 @@ -99498,7 +99413,7 @@ paths: application/json: schema: type: array - items: *671 + items: *673 examples: default: value: @@ -99608,9 +99523,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -99641,9 +99556,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -99663,7 +99578,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: - - *59 + - *63 responses: '204': description: if the person is followed by the authenticated user @@ -99693,7 +99608,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *59 + - *63 responses: '204': description: Response @@ -99718,7 +99633,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *59 + - *63 responses: '204': description: Response @@ -99754,7 +99669,7 @@ paths: application/json: schema: type: array - items: &672 + items: &674 title: GPG Key description: A unique encryption key type: object @@ -99885,7 +99800,7 @@ paths: - subkeys - revoked examples: - default: &697 + default: &699 value: - id: 3 name: Octocat's GPG Key @@ -99917,7 +99832,7 @@ paths: revoked: false raw_key: string headers: - Link: *54 + Link: *58 '304': *37 '404': *6 '403': *29 @@ -99970,9 +99885,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *674 examples: - default: &673 + default: &675 value: id: 3 name: Octocat's GPG Key @@ -100029,7 +99944,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &674 + - &676 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -100041,9 +99956,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *674 examples: - default: *673 + default: *675 '404': *6 '304': *37 '403': *29 @@ -100066,7 +99981,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *674 + - *676 responses: '204': description: Response @@ -100209,7 +100124,7 @@ paths: suspended_at: suspended_by: headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -100255,11 +100170,11 @@ paths: type: string repositories: type: array - items: *66 + items: *70 examples: - default: *135 + default: *141 headers: - Link: *54 + Link: *58 '404': *6 '403': *29 '304': *37 @@ -100282,7 +100197,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *132 + - *138 responses: '204': description: Response @@ -100308,7 +100223,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *132 + - *138 responses: '204': description: Response @@ -100342,12 +100257,12 @@ paths: application/json: schema: anyOf: - - *214 + - *220 - type: object properties: {} additionalProperties: false examples: - default: *215 + default: *221 '204': description: Response when there are no restrictions x-github: @@ -100371,7 +100286,7 @@ paths: required: true content: application/json: - schema: *520 + schema: *524 examples: default: value: @@ -100382,7 +100297,7 @@ paths: description: Response content: application/json: - schema: *214 + schema: *220 examples: default: value: @@ -100463,7 +100378,7 @@ paths: - closed - all default: open - - *222 + - *228 - name: sort description: What to sort results by. in: query @@ -100475,8 +100390,8 @@ paths: - updated - comments default: created - - *48 - - *72 + - *52 + - *76 - *17 - *19 responses: @@ -100486,11 +100401,11 @@ paths: application/json: schema: type: array - items: *82 + items: *86 examples: - default: *223 + default: *229 headers: - Link: *54 + Link: *58 '404': *6 '304': *37 x-github: @@ -100521,7 +100436,7 @@ paths: application/json: schema: type: array - items: &675 + items: &677 title: Key description: Key type: object @@ -100572,7 +100487,7 @@ paths: verified: false read_only: false headers: - Link: *54 + Link: *58 '304': *37 '404': *6 '403': *29 @@ -100622,9 +100537,9 @@ paths: description: Response content: application/json: - schema: *675 + schema: *677 examples: - default: &676 + default: &678 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -100657,15 +100572,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *550 + - *554 responses: '200': description: Response content: application/json: - schema: *675 + schema: *677 examples: - default: *676 + default: *678 '404': *6 '304': *37 '403': *29 @@ -100688,7 +100603,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *550 + - *554 responses: '204': description: Response @@ -100721,7 +100636,7 @@ paths: application/json: schema: type: array - items: &677 + items: &679 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -100778,7 +100693,7 @@ paths: - id - type - login - plan: *86 + plan: *90 required: - billing_cycle - next_billing_date @@ -100789,7 +100704,7 @@ paths: - account - plan examples: - default: &678 + default: &680 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -100822,7 +100737,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *54 + Link: *58 '304': *37 '401': *25 '404': *6 @@ -100851,11 +100766,11 @@ paths: application/json: schema: type: array - items: *677 + items: *679 examples: - default: *678 + default: *680 headers: - Link: *54 + Link: *58 '304': *37 '401': *25 x-github: @@ -100893,7 +100808,7 @@ paths: application/json: schema: type: array - items: *228 + items: *234 examples: default: value: @@ -100970,7 +100885,7 @@ paths: type: User site_admin: false headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -100995,13 +100910,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *63 + - *67 responses: '200': description: Response content: application/json: - schema: *228 + schema: *234 examples: default: value: @@ -101059,7 +100974,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *63 + - *67 requestBody: required: true content: @@ -101084,7 +100999,7 @@ paths: description: Response content: application/json: - schema: *228 + schema: *234 examples: default: value: @@ -101152,7 +101067,7 @@ paths: application/json: schema: type: array - items: *230 + items: *236 examples: default: value: @@ -101305,7 +101220,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -101405,7 +101320,7 @@ paths: description: Response content: application/json: - schema: *230 + schema: *236 examples: default: value: @@ -101585,7 +101500,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *231 + - *237 - name: exclude in: query required: false @@ -101598,7 +101513,7 @@ paths: description: Response content: application/json: - schema: *230 + schema: *236 examples: default: value: @@ -101792,7 +101707,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *231 + - *237 responses: '302': description: Response @@ -101818,7 +101733,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *231 + - *237 responses: '204': description: Response @@ -101847,8 +101762,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *231 - - *679 + - *237 + - *681 responses: '204': description: Response @@ -101872,7 +101787,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *231 + - *237 - *17 - *19 responses: @@ -101882,11 +101797,11 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: *243 + default: *249 headers: - Link: *54 + Link: *58 '404': *6 x-github: githubCloudOnly: false @@ -101919,11 +101834,11 @@ paths: application/json: schema: type: array - items: *61 + items: *65 examples: - default: *99 + default: *103 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -101963,7 +101878,7 @@ paths: - docker - nuget - container - - *680 + - *682 - *19 - *17 responses: @@ -101973,10 +101888,10 @@ paths: application/json: schema: type: array - items: *237 + items: *243 examples: - default: *681 - '400': *682 + default: *683 + '400': *684 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -101996,16 +101911,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *239 - - *240 + - *245 + - *246 responses: '200': description: Response content: application/json: - schema: *237 + schema: *243 examples: - default: &698 + default: &700 value: id: 40201 name: octo-name @@ -102118,8 +102033,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *239 - - *240 + - *245 + - *246 responses: '204': description: Response @@ -102149,8 +102064,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *239 - - *240 + - *245 + - *246 - name: token description: package token schema: @@ -102182,8 +102097,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: - - *239 - - *240 + - *245 + - *246 - *19 - *17 - name: state @@ -102203,7 +102118,7 @@ paths: application/json: schema: type: array - items: *241 + items: *247 examples: default: value: @@ -102252,15 +102167,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *239 - - *240 - - *242 + - *245 + - *246 + - *248 responses: '200': description: Response content: application/json: - schema: *241 + schema: *247 examples: default: value: @@ -102296,9 +102211,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *239 - - *240 - - *242 + - *245 + - *246 + - *248 responses: '204': description: Response @@ -102328,9 +102243,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *239 - - *240 - - *242 + - *245 + - *246 + - *248 responses: '204': description: Response @@ -102367,11 +102282,11 @@ paths: application/json: schema: type: array - items: *671 + items: *673 examples: - default: *683 + default: *685 headers: - Link: *54 + Link: *58 '304': *37 '404': *6 '403': *29 @@ -102480,9 +102395,9 @@ paths: application/json: schema: type: array - items: *66 + items: *70 examples: - default: &690 + default: &692 summary: Default response value: - id: 1296269 @@ -102603,7 +102518,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *54 + Link: *58 '422': *15 '304': *37 '403': *29 @@ -102786,9 +102701,9 @@ paths: description: Response content: application/json: - schema: *333 + schema: *335 examples: - default: *335 + default: *337 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -102826,11 +102741,11 @@ paths: application/json: schema: type: array - items: *522 + items: *526 examples: - default: *684 + default: *686 headers: - Link: *54 + Link: *58 '304': *37 '404': *6 '403': *29 @@ -102851,12 +102766,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *218 + - *224 responses: '204': description: Response '403': *29 - '409': *47 + '409': *51 '404': *6 '304': *37 x-github: @@ -102874,11 +102789,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *218 + - *224 responses: '204': description: Response - '409': *47 + '409': *51 '304': *37 '404': *6 '403': *29 @@ -102907,7 +102822,7 @@ paths: application/json: schema: type: array - items: &685 + items: &687 title: Social account description: Social media account type: object @@ -102922,12 +102837,12 @@ paths: - provider - url examples: - default: &686 + default: &688 value: - provider: twitter url: https://twitter.com/github headers: - Link: *54 + Link: *58 '304': *37 '404': *6 '403': *29 @@ -102984,9 +102899,9 @@ paths: application/json: schema: type: array - items: *685 + items: *687 examples: - default: *686 + default: *688 '422': *15 '304': *37 '404': *6 @@ -103073,7 +102988,7 @@ paths: application/json: schema: type: array - items: &687 + items: &689 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -103093,7 +103008,7 @@ paths: - title - created_at examples: - default: &706 + default: &717 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -103104,7 +103019,7 @@ paths: title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' headers: - Link: *54 + Link: *58 '304': *37 '404': *6 '403': *29 @@ -103157,9 +103072,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *689 examples: - default: &688 + default: &690 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -103189,7 +103104,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: - - &689 + - &691 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -103201,9 +103116,9 @@ paths: description: Response content: application/json: - schema: *687 + schema: *689 examples: - default: *688 + default: *690 '404': *6 '304': *37 '403': *29 @@ -103226,7 +103141,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: - - *689 + - *691 responses: '204': description: Response @@ -103255,7 +103170,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &707 + - &718 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 @@ -103268,7 +103183,7 @@ paths: - created - updated default: created - - *48 + - *52 - *17 - *19 responses: @@ -103278,13 +103193,13 @@ paths: application/json: schema: type: array - items: *66 + items: *70 examples: - default-response: *690 + default-response: *692 application/vnd.github.v3.star+json: schema: type: array - items: &708 + items: &719 title: Starred Repository description: Starred Repository type: object @@ -103292,7 +103207,7 @@ paths: starred_at: type: string format: date-time - repo: *66 + repo: *70 required: - starred_at - repo @@ -103420,7 +103335,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -103440,8 +103355,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: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response if this repository is starred by you @@ -103469,8 +103384,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -103494,8 +103409,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *327 - - *328 + - *332 + - *333 responses: '204': description: Response @@ -103528,11 +103443,11 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: *243 + default: *249 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -103567,7 +103482,7 @@ paths: application/json: schema: type: array - items: *312 + items: *319 examples: default: value: @@ -103618,7 +103533,7 @@ paths: updated_at: '2017-08-17T12:37:15Z' type: Organization headers: - Link: *54 + Link: *58 '304': *37 '404': *6 '403': *29 @@ -103645,7 +103560,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *88 + - *92 responses: '200': description: Response @@ -103653,10 +103568,10 @@ paths: application/json: schema: oneOf: - - *664 - - *663 + - *666 + - *665 examples: - default-response: &692 + default-response: &694 summary: Default response value: login: octocat @@ -103691,7 +103606,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &693 + response-with-git-hub-plan-information: &695 summary: Response with GitHub plan information value: login: octocat @@ -103754,7 +103669,7 @@ paths: required: true schema: type: string - - *255 + - *261 requestBody: required: true description: Details of the draft item to create in the project. @@ -103788,9 +103703,9 @@ paths: description: Response content: application/json: - schema: *261 + schema: *267 examples: - draft_issue: *262 + draft_issue: *268 '304': *37 '403': *29 '401': *25 @@ -103813,7 +103728,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *691 + - *693 - *17 responses: '200': @@ -103824,7 +103739,7 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: Link: example: ; rel="next" @@ -103854,7 +103769,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *59 + - *63 responses: '200': description: Response @@ -103862,11 +103777,11 @@ paths: application/json: schema: oneOf: - - *664 - - *663 + - *666 + - *665 examples: - default-response: *692 - response-with-git-hub-plan-information: *693 + default-response: *694 + response-with-git-hub-plan-information: *695 '404': *6 x-github: githubCloudOnly: false @@ -103890,9 +103805,9 @@ paths: url: https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *40 - - *41 - - *59 + - *45 + - *46 + - *63 requestBody: required: true content: @@ -103916,8 +103831,8 @@ paths: required: - subject_digests examples: - default: *694 - withPredicateType: *695 + default: *696 + withPredicateType: *697 responses: '200': description: Response @@ -103970,7 +103885,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *696 + default: *698 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103988,7 +103903,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk parameters: - - *59 + - *63 requestBody: required: true content: @@ -104053,7 +103968,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *59 + - *63 - name: subject_digest description: Subject Digest in: path @@ -104084,7 +103999,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-id parameters: - - *59 + - *63 - name: attestation_id description: Attestation ID in: path @@ -104120,9 +104035,9 @@ paths: url: https://docs.github.com/rest/users/attestations#list-attestations parameters: - *17 - - *40 - - *41 - - *59 + - *45 + - *46 + - *63 - name: subject_digest description: Subject Digest in: path @@ -104175,12 +104090,12 @@ paths: initiator: type: string examples: - default: *389 + default: *393 '201': description: Response content: application/json: - schema: *152 + schema: *158 examples: default: value: @@ -104206,7 +104121,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: - - *59 + - *63 responses: '200': description: Response @@ -104214,9 +104129,9 @@ paths: application/json: schema: type: array - items: *237 + items: *243 examples: - default: *681 + default: *683 '403': *29 '401': *25 x-github: @@ -104239,7 +104154,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -104249,7 +104164,7 @@ paths: application/json: schema: type: array - items: *94 + items: *98 examples: default: value: @@ -104311,8 +104226,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *59 - *63 + - *67 - *17 - *19 responses: @@ -104322,7 +104237,7 @@ paths: application/json: schema: type: array - items: *94 + items: *98 examples: default: value: @@ -104399,7 +104314,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -104409,7 +104324,7 @@ paths: application/json: schema: type: array - items: *94 + items: *98 examples: default: value: @@ -104467,7 +104382,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -104479,9 +104394,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104498,7 +104413,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *59 + - *63 - *17 - *19 responses: @@ -104510,9 +104425,9 @@ paths: type: array items: *4 examples: - default: *58 + default: *62 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104529,7 +104444,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *59 + - *63 - name: target_user in: path required: true @@ -104556,8 +104471,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *59 - - *72 + - *63 + - *76 - *17 - *19 responses: @@ -104567,11 +104482,11 @@ paths: application/json: schema: type: array - items: *73 + items: *77 examples: - default: *74 + default: *78 headers: - Link: *54 + Link: *58 '422': *15 x-github: githubCloudOnly: false @@ -104590,7 +104505,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -104600,11 +104515,11 @@ paths: application/json: schema: type: array - items: *672 + items: *674 examples: - default: *697 + default: *699 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104626,7 +104541,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *59 + - *63 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -104698,7 +104613,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *59 + - *63 responses: '200': description: Response @@ -104706,7 +104621,7 @@ paths: application/json: schema: *22 examples: - default: *519 + default: *523 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104724,7 +104639,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -104759,7 +104674,7 @@ paths: - id: 1 key: ssh-rsa AAA... headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104779,7 +104694,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -104789,11 +104704,11 @@ paths: application/json: schema: type: array - items: *61 + items: *65 examples: - default: *99 + default: *103 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104830,8 +104745,8 @@ paths: - docker - nuget - container - - *680 - - *59 + - *682 + - *63 - *19 - *17 responses: @@ -104841,12 +104756,12 @@ paths: application/json: schema: type: array - items: *237 + items: *243 examples: - default: *681 + default: *683 '403': *29 '401': *25 - '400': *682 + '400': *684 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104866,17 +104781,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *239 - - *240 - - *59 + - *245 + - *246 + - *63 responses: '200': description: Response content: application/json: - schema: *237 + schema: *243 examples: - default: *698 + default: *700 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104897,9 +104812,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *239 - - *240 - - *59 + - *245 + - *246 + - *63 responses: '204': description: Response @@ -104931,9 +104846,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *239 - - *240 - - *59 + - *245 + - *246 + - *63 - name: token description: package token schema: @@ -104965,9 +104880,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: - - *239 - - *240 - - *59 + - *245 + - *246 + - *63 responses: '200': description: Response @@ -104975,7 +104890,7 @@ paths: application/json: schema: type: array - items: *241 + items: *247 examples: default: value: @@ -105033,16 +104948,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *239 - - *240 - - *242 - - *59 + - *245 + - *246 + - *248 + - *63 responses: '200': description: Response content: application/json: - schema: *241 + schema: *247 examples: default: value: @@ -105077,10 +104992,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *239 - - *240 - - *59 - - *242 + - *245 + - *246 + - *63 + - *248 responses: '204': description: Response @@ -105112,10 +105027,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *239 - - *240 - - *59 - - *242 + - *245 + - *246 + - *63 + - *248 responses: '204': description: Response @@ -105139,15 +105054,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-user parameters: - - *59 + - *63 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *40 - - *41 + - *45 + - *46 - *17 responses: '200': @@ -105156,11 +105071,11 @@ paths: application/json: schema: type: array - items: *253 + items: *259 examples: - default: *254 + default: *260 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -105180,18 +105095,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *255 - - *59 + - *261 + - *63 responses: '200': description: Response content: application/json: - schema: *253 + schema: *259 examples: - default: *254 + default: *260 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -105211,11 +105126,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *255 - - *59 + - *261 + - *63 - *17 - - *40 - - *41 + - *45 + - *46 responses: '200': description: Response @@ -105223,14 +105138,124 @@ paths: application/json: schema: type: array - items: *259 + items: *265 examples: - default: *699 + default: *701 headers: - Link: *54 + Link: *58 + '304': *37 + '403': *29 + '401': *25 + x-github: + githubCloudOnly: false + 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: + - *63 + - *261 + 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: *702 + 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: *703 + 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: *704 + iteration_field: *705 + responses: + '201': + description: Response + content: + application/json: + schema: *265 + examples: + text_field: *706 + number_field: *707 + date_field: *708 + single_select_field: *709 + iteration_field: *710 '304': *37 '403': *29 '401': *25 + '422': *15 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105247,19 +105272,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *255 - - *700 - - *59 + - *261 + - *711 + - *63 responses: '200': description: Response content: application/json: - schema: *259 + schema: *265 examples: - default: *701 + default: *712 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -105280,10 +105305,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *255 - - *59 - - *40 - - *41 + - *261 + - *63 + - *45 + - *46 - *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) @@ -105313,11 +105338,11 @@ paths: application/json: schema: type: array - items: *263 + items: *269 examples: - default: *264 + default: *270 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -105336,8 +105361,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - - *59 - - *255 + - *63 + - *261 requestBody: required: true description: Details of the item to add to the project. @@ -105374,10 +105399,10 @@ paths: description: Response content: application/json: - schema: *261 + schema: *267 examples: - issue: *262 - pull_request: *262 + issue: *268 + pull_request: *268 '304': *37 '403': *29 '401': *25 @@ -105397,9 +105422,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *255 - - *59 - - *265 + - *261 + - *63 + - *271 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -105419,11 +105444,11 @@ paths: description: Response content: application/json: - schema: *263 + schema: *269 examples: - default: *264 + default: *270 headers: - Link: *54 + Link: *58 '304': *37 '403': *29 '401': *25 @@ -105442,9 +105467,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *255 - - *59 - - *265 + - *261 + - *63 + - *271 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -105514,13 +105539,13 @@ paths: description: Response content: application/json: - schema: *263 + schema: *269 examples: - text_field: *264 - number_field: *264 - date_field: *264 - single_select_field: *264 - iteration_field: *264 + text_field: *270 + number_field: *270 + date_field: *270 + single_select_field: *270 + iteration_field: *270 '401': *25 '403': *29 '404': *6 @@ -105540,9 +105565,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *255 - - *59 - - *265 + - *261 + - *63 + - *271 responses: '204': description: Response @@ -105569,7 +105594,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -105579,7 +105604,7 @@ paths: application/json: schema: type: array - items: *94 + items: *98 examples: default: value: @@ -105644,7 +105669,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -105654,7 +105679,7 @@ paths: application/json: schema: type: array - items: *94 + items: *98 examples: default: value: @@ -105717,7 +105742,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *59 + - *63 - name: type description: Limit results to repositories of the specified type. in: query @@ -105760,11 +105785,11 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: *243 + default: *249 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105784,12 +105809,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-a-user parameters: - - *59 - - *106 - - *108 - - *107 - - *702 - - *109 + - *63 + - *112 + - *114 + - *113 + - *713 + - *115 responses: '200': description: Response when getting a billing premium request usage report @@ -105896,8 +105921,8 @@ paths: '400': *14 '403': *29 '404': *6 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105917,10 +105942,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-a-user parameters: - - *59 - - *106 - - *703 - - *107 + - *63 + - *112 + - *714 + - *113 responses: '200': description: Response when getting a billing usage report @@ -105990,8 +106015,8 @@ paths: repositoryName: user/example '400': *14 '403': *29 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106014,13 +106039,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-a-user parameters: - - *59 - - *106 - - *108 - - *107 - - *704 - - *109 - - *705 + - *63 + - *112 + - *114 + - *113 + - *715 + - *115 + - *716 responses: '200': description: Response when getting a billing usage summary @@ -106125,8 +106150,8 @@ paths: '400': *14 '403': *29 '404': *6 - '500': *103 - '503': *104 + '500': *109 + '503': *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106144,7 +106169,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -106154,11 +106179,11 @@ paths: application/json: schema: type: array - items: *685 + items: *687 examples: - default: *686 + default: *688 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106176,7 +106201,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -106186,11 +106211,11 @@ paths: application/json: schema: type: array - items: *687 + items: *689 examples: - default: *706 + default: *717 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106212,9 +106237,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *59 - - *707 - - *48 + - *63 + - *718 + - *52 - *17 - *19 responses: @@ -106225,13 +106250,13 @@ paths: schema: anyOf: - type: array - items: *708 + items: *719 - type: array - items: *66 + items: *70 examples: - default-response: *690 + default-response: *692 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106248,7 +106273,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *59 + - *63 - *17 - *19 responses: @@ -106258,11 +106283,11 @@ paths: application/json: schema: type: array - items: *143 + items: *149 examples: - default: *243 + default: *249 headers: - Link: *54 + Link: *58 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106388,7 +106413,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &709 + enterprise: &720 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -106446,7 +106471,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &710 + installation: &721 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -106465,7 +106490,7 @@ x-webhooks: required: - id - node_id - organization: &711 + organization: &722 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -106525,13 +106550,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &712 + repository: &723 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &742 + properties: &753 id: description: Unique identifier of the repository example: 42 @@ -106551,8 +106576,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *83 - required: *84 + properties: *87 + required: *88 nullable: true organization: title: Simple User @@ -107214,7 +107239,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &743 + required: &754 - archive_url - assignees_url - blobs_url @@ -107365,10 +107390,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -107444,11 +107469,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - rule: &713 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + rule: &724 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) @@ -107671,11 +107696,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - rule: *713 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + rule: *724 sender: *4 required: - action @@ -107858,11 +107883,11 @@ x-webhooks: - everyone required: - from - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - rule: *713 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + rule: *724 sender: *4 required: - action @@ -107946,7 +107971,7 @@ x-webhooks: type: string enum: - completed - check_run: &715 + check_run: &726 title: CheckRun description: A check performed on the code of a given code change type: object @@ -107999,8 +108024,8 @@ x-webhooks: type: string pull_requests: type: array - items: *406 - repository: *143 + items: *410 + repository: *149 status: example: completed type: string @@ -108037,7 +108062,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *714 + deployment: *725 details_url: example: https://example.com type: string @@ -108087,7 +108112,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *406 + items: *410 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -108122,10 +108147,10 @@ x-webhooks: - output - app - pull_requests - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 sender: *4 required: - check_run @@ -108518,11 +108543,11 @@ x-webhooks: type: string enum: - created - check_run: *715 - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + check_run: *726 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 sender: *4 required: - check_run @@ -108918,11 +108943,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *715 - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + check_run: *726 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 requested_action: description: The action requested by the user. type: object @@ -109327,11 +109352,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *715 - installation: *710 - enterprise: *709 - organization: *711 - repository: *712 + check_run: *726 + installation: *721 + enterprise: *720 + organization: *722 + repository: *723 sender: *4 required: - check_run @@ -110308,10 +110333,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -110584,6 +110609,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -110996,10 +111026,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -111267,6 +111297,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -111678,10 +111713,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -111847,7 +111882,7 @@ x-webhooks: required: - login - id - dismissed_comment: *422 + dismissed_comment: *426 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -111992,20 +112027,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &716 + commit_oid: &727 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: *709 - installation: *710 - organization: *711 - ref: &717 + enterprise: *720 + installation: *721 + organization: *722 + ref: &728 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: *712 + repository: *723 sender: *4 required: - action @@ -112170,7 +112205,7 @@ x-webhooks: required: - login - id - dismissed_comment: *422 + dismissed_comment: *426 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -112400,12 +112435,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -112500,7 +112535,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *422 + dismissed_comment: *426 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -112671,12 +112706,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -112842,7 +112877,7 @@ x-webhooks: required: - login - id - dismissed_comment: *422 + dismissed_comment: *426 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -113008,12 +113043,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -113113,7 +113148,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *422 + dismissed_comment: *426 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -113281,16 +113316,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *712 + repository: *723 sender: *4 required: - action @@ -113387,7 +113422,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *422 + dismissed_comment: *426 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -113527,12 +113562,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *716 - enterprise: *709 - installation: *710 - organization: *711 - ref: *717 - repository: *712 + commit_oid: *727 + enterprise: *720 + installation: *721 + organization: *722 + ref: *728 + repository: *723 sender: *4 required: - action @@ -113789,10 +113824,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -113872,18 +113907,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *711 - pusher_type: &718 + organization: *722 + pusher_type: &729 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &719 + ref: &730 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -113893,7 +113928,7 @@ x-webhooks: enum: - tag - branch - repository: *712 + repository: *723 sender: *4 required: - ref @@ -113975,10 +114010,10 @@ x-webhooks: type: string enum: - created - definition: *266 - enterprise: *709 - installation: *710 - organization: *711 + definition: *272 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -114063,9 +114098,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -114142,10 +114177,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *266 - enterprise: *709 - installation: *710 - organization: *711 + definition: *272 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -114222,10 +114257,10 @@ x-webhooks: type: string enum: - updated - definition: *266 - enterprise: *709 - installation: *710 - organization: *711 + definition: *272 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -114302,19 +114337,19 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - repository: *712 - organization: *711 + enterprise: *720 + installation: *721 + repository: *723 + organization: *722 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *102 + items: *108 old_property_values: type: array description: The old custom property values for the repository. - items: *102 + items: *108 required: - action - repository @@ -114390,18 +114425,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - pusher_type: *718 - ref: *719 + enterprise: *720 + installation: *721 + organization: *722 + pusher_type: *729 + ref: *730 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *712 + repository: *723 sender: *4 required: - ref @@ -114485,11 +114520,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *482 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -114573,11 +114608,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *482 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -114661,11 +114696,11 @@ x-webhooks: type: string enum: - created - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *482 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -114747,11 +114782,11 @@ x-webhooks: type: string enum: - dismissed - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *482 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -114833,11 +114868,11 @@ x-webhooks: type: string enum: - fixed - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *482 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -114920,11 +114955,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *482 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -115006,11 +115041,11 @@ x-webhooks: type: string enum: - reopened - alert: *478 - installation: *710 - organization: *711 - enterprise: *709 - repository: *712 + alert: *482 + installation: *721 + organization: *722 + enterprise: *720 + repository: *723 sender: *4 required: - action @@ -115087,9 +115122,9 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - key: &720 + enterprise: *720 + installation: *721 + key: &731 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -115125,8 +115160,8 @@ x-webhooks: - verified - created_at - read_only - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -115203,11 +115238,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - key: *720 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + key: *731 + organization: *722 + repository: *723 sender: *4 required: - action @@ -115768,12 +115803,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: &724 + workflow: &735 title: Workflow type: object nullable: true @@ -116499,13 +116534,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *484 + deployment: *488 pull_requests: type: array - items: *571 - repository: *712 - organization: *711 - installation: *710 + items: *575 + repository: *723 + organization: *722 + installation: *721 sender: *4 responses: '200': @@ -116576,7 +116611,7 @@ x-webhooks: type: string enum: - approved - approver: &721 + approver: &732 type: object properties: avatar_url: @@ -116619,11 +116654,11 @@ x-webhooks: type: string comment: type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - reviewers: &722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + reviewers: &733 type: array items: type: object @@ -116702,7 +116737,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &723 + workflow_job_run: &734 type: object properties: conclusion: @@ -117433,18 +117468,18 @@ x-webhooks: type: string enum: - rejected - approver: *721 + approver: *732 comment: type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - reviewers: *722 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + reviewers: *733 sender: *4 since: type: string - workflow_job_run: *723 + workflow_job_run: *734 workflow_job_runs: type: array items: @@ -118148,13 +118183,13 @@ x-webhooks: type: string enum: - requested - enterprise: *709 + enterprise: *720 environment: type: string - installation: *710 - organization: *711 - repository: *712 - requestor: &729 + installation: *721 + organization: *722 + repository: *723 + requestor: &740 title: User type: object nullable: true @@ -120053,12 +120088,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *724 + workflow: *735 workflow_run: title: Deployment Workflow Run type: object @@ -120738,7 +120773,7 @@ x-webhooks: type: string enum: - answered - answer: &727 + answer: &738 type: object properties: author_association: @@ -120895,7 +120930,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &725 + discussion: &736 title: Discussion description: A Discussion in a repository. type: object @@ -121181,7 +121216,7 @@ x-webhooks: - id labels: type: array - items: *533 + items: *537 required: - repository_url - category @@ -121203,10 +121238,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -121333,11 +121368,11 @@ x-webhooks: - from required: - category - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -121420,11 +121455,11 @@ x-webhooks: type: string enum: - closed - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -121506,7 +121541,7 @@ x-webhooks: type: string enum: - created - comment: &726 + comment: &737 type: object properties: author_association: @@ -121663,11 +121698,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -121750,12 +121785,12 @@ x-webhooks: type: string enum: - deleted - comment: *726 - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + comment: *737 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -121850,12 +121885,12 @@ x-webhooks: - from required: - body - comment: *726 - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + comment: *737 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -121939,11 +121974,11 @@ x-webhooks: type: string enum: - created - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122025,11 +122060,11 @@ x-webhooks: type: string enum: - deleted - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122129,11 +122164,11 @@ x-webhooks: type: string required: - from - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122215,10 +122250,10 @@ x-webhooks: type: string enum: - labeled - discussion: *725 - enterprise: *709 - installation: *710 - label: &728 + discussion: *736 + enterprise: *720 + installation: *721 + label: &739 title: Label type: object properties: @@ -122250,8 +122285,8 @@ x-webhooks: - color - default - description - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122334,11 +122369,11 @@ x-webhooks: type: string enum: - locked - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122420,11 +122455,11 @@ x-webhooks: type: string enum: - pinned - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122506,11 +122541,11 @@ x-webhooks: type: string enum: - reopened - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122595,16 +122630,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *725 - new_repository: *712 + new_discussion: *736 + new_repository: *723 required: - new_discussion - new_repository - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122687,10 +122722,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *725 - old_answer: *727 - organization: *711 - repository: *712 + discussion: *736 + old_answer: *738 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122772,12 +122807,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *725 - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122860,11 +122895,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -122946,11 +122981,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *725 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + discussion: *736 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -123023,7 +123058,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *709 + enterprise: *720 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -123683,9 +123718,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *710 - organization: *711 - repository: *712 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - forkee @@ -123831,9 +123866,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 pages: description: The pages that were updated. type: array @@ -123870,7 +123905,7 @@ x-webhooks: - action - sha - html_url - repository: *712 + repository: *723 sender: *4 required: - pages @@ -123946,10 +123981,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 + enterprise: *720 installation: *22 - organization: *711 - repositories: &730 + organization: *722 + repositories: &741 description: An array of repository objects that the installation can access. type: array @@ -123975,8 +124010,8 @@ x-webhooks: - name - full_name - private - repository: *712 - requester: *729 + repository: *723 + requester: *740 sender: *4 required: - action @@ -124051,11 +124086,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 + enterprise: *720 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *722 + repositories: *741 + repository: *723 requester: nullable: true sender: *4 @@ -124131,11 +124166,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *709 + enterprise: *720 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *722 + repositories: *741 + repository: *723 requester: nullable: true sender: *4 @@ -124211,10 +124246,10 @@ x-webhooks: type: string enum: - added - enterprise: *709 + enterprise: *720 installation: *22 - organization: *711 - repositories_added: &731 + organization: *722 + repositories_added: &742 description: An array of repository objects, which were added to the installation. type: array @@ -124260,15 +124295,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *712 - repository_selection: &732 + repository: *723 + repository_selection: &743 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *729 + requester: *740 sender: *4 required: - action @@ -124347,10 +124382,10 @@ x-webhooks: type: string enum: - removed - enterprise: *709 + enterprise: *720 installation: *22 - organization: *711 - repositories_added: *731 + organization: *722 + repositories_added: *742 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -124377,9 +124412,9 @@ x-webhooks: - name - full_name - private - repository: *712 - repository_selection: *732 - requester: *729 + repository: *723 + repository_selection: *743 + requester: *740 sender: *4 required: - action @@ -124458,11 +124493,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *709 + enterprise: *720 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *722 + repositories: *741 + repository: *723 requester: nullable: true sender: *4 @@ -124640,10 +124675,10 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 target_type: type: string @@ -124722,11 +124757,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *709 + enterprise: *720 installation: *22 - organization: *711 - repositories: *730 - repository: *712 + organization: *722 + repositories: *741 + repository: *723 requester: nullable: true sender: *4 @@ -124850,8 +124885,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *67 - required: *68 + properties: *71 + required: *72 reactions: title: Reactions type: object @@ -124978,8 +125013,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -125773,8 +125808,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 state: description: State of the issue; either 'open' or 'closed' type: string @@ -125790,7 +125825,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -126123,8 +126158,8 @@ x-webhooks: - state - locked - assignee - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -126204,7 +126239,7 @@ x-webhooks: type: string enum: - deleted - comment: &733 + comment: &744 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -126369,8 +126404,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -127160,8 +127195,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 state: description: State of the issue; either 'open' or 'closed' type: string @@ -127177,7 +127212,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -127512,8 +127547,8 @@ x-webhooks: - state - locked - assignee - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -127593,7 +127628,7 @@ x-webhooks: type: string enum: - edited - changes: &762 + changes: &773 description: The changes to the comment. type: object properties: @@ -127605,9 +127640,9 @@ x-webhooks: type: string required: - from - comment: *733 - enterprise: *709 - installation: *710 + comment: *744 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128400,8 +128435,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128417,7 +128452,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -128750,8 +128785,8 @@ x-webhooks: - state - locked - assignee - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -128835,15 +128870,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *82 + blocked_issue: *86 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *82 - blocking_issue_repo: *66 - installation: *710 - organization: *711 - repository: *712 + blocking_issue: *86 + blocking_issue_repo: *70 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -128931,15 +128966,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *82 + blocked_issue: *86 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *82 - blocking_issue_repo: *66 - installation: *710 - organization: *711 - repository: *712 + blocking_issue: *86 + blocking_issue_repo: *70 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -129026,15 +129061,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *82 - blocked_issue_repo: *66 + blocked_issue: *86 + blocked_issue_repo: *70 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *82 - installation: *710 - organization: *711 - repository: *712 + blocking_issue: *86 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -129122,15 +129157,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *82 - blocked_issue_repo: *66 + blocked_issue: *86 + blocked_issue_repo: *70 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *82 - installation: *710 - organization: *711 - repository: *712 + blocking_issue: *86 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -129215,10 +129250,10 @@ x-webhooks: type: string enum: - assigned - assignee: *729 - enterprise: *709 - installation: *710 - issue: &736 + assignee: *740 + enterprise: *720 + installation: *721 + issue: &747 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -130007,11 +130042,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130027,7 +130062,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -130128,8 +130163,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -130209,8 +130244,8 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -131004,11 +131039,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131024,7 +131059,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -131260,8 +131295,8 @@ x-webhooks: required: - state - closed_at - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -131340,8 +131375,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -132126,11 +132161,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132146,7 +132181,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -132246,8 +132281,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -132326,8 +132361,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -133134,11 +133169,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133154,7 +133189,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -133233,7 +133268,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &734 + milestone: &745 title: Milestone description: A collection of related issues and pull requests. type: object @@ -133371,8 +133406,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -133471,8 +133506,8 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134261,11 +134296,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134278,7 +134313,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *219 + type: *225 title: description: Title of the issue type: string @@ -134382,9 +134417,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *728 - organization: *711 - repository: *712 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -134464,8 +134499,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135253,11 +135288,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135270,7 +135305,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *219 + type: *225 title: description: Title of the issue type: string @@ -135374,9 +135409,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *728 - organization: *711 - repository: *712 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -135456,8 +135491,8 @@ x-webhooks: type: string enum: - locked - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136269,11 +136304,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136286,7 +136321,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *219 + type: *225 title: description: Title of the issue type: string @@ -136367,8 +136402,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -136447,8 +136482,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137254,11 +137289,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137274,7 +137309,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -137352,9 +137387,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *734 - organization: *711 - repository: *712 + milestone: *745 + organization: *722 + repository: *723 sender: *4 required: - action @@ -138222,11 +138257,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138319,7 +138354,7 @@ x-webhooks: required: - login - id - type: *219 + type: *225 required: - id - number @@ -138788,8 +138823,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139578,11 +139613,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139598,7 +139633,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -139698,8 +139733,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -139779,9 +139814,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *709 - installation: *710 - issue: &735 + enterprise: *720 + installation: *721 + issue: &746 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -140564,11 +140599,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140584,7 +140619,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -140684,8 +140719,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -140764,8 +140799,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141575,11 +141610,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141673,9 +141708,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *219 - organization: *711 - repository: *712 + type: *225 + organization: *722 + repository: *723 sender: *4 required: - action @@ -142541,11 +142576,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142561,7 +142596,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -143129,11 +143164,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *709 - installation: *710 - issue: *735 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + issue: *746 + organization: *722 + repository: *723 sender: *4 required: - action @@ -143213,12 +143248,12 @@ x-webhooks: type: string enum: - typed - enterprise: *709 - installation: *710 - issue: *736 - type: *219 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + issue: *747 + type: *225 + organization: *722 + repository: *723 sender: *4 required: - action @@ -143299,7 +143334,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &765 + assignee: &776 title: User type: object nullable: true @@ -143369,11 +143404,11 @@ x-webhooks: required: - login - id - enterprise: *709 - installation: *710 - issue: *736 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + issue: *747 + organization: *722 + repository: *723 sender: *4 required: - action @@ -143452,12 +143487,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *709 - installation: *710 - issue: *736 - label: *728 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + issue: *747 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -143537,8 +143572,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144348,11 +144383,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *649 - issue_dependencies_summary: *650 + sub_issues_summary: *653 + issue_dependencies_summary: *654 issue_field_values: type: array - items: *651 + items: *655 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144368,7 +144403,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *219 + type: *225 updated_at: type: string format: date-time @@ -144446,8 +144481,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -144527,11 +144562,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *709 - installation: *710 - issue: *735 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + issue: *746 + organization: *722 + repository: *723 sender: *4 required: - action @@ -144610,12 +144645,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *709 - installation: *710 - issue: *736 - type: *219 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + issue: *747 + type: *225 + organization: *722 + repository: *723 sender: *4 required: - action @@ -144695,11 +144730,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -144777,11 +144812,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -144891,11 +144926,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - label: *728 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + label: *739 + organization: *722 + repository: *723 sender: *4 required: - action @@ -144977,9 +145012,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: &737 + enterprise: *720 + installation: *721 + marketplace_purchase: &748 title: Marketplace Purchase type: object required: @@ -145062,8 +145097,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *711 - previous_marketplace_purchase: &738 + organization: *722 + previous_marketplace_purchase: &749 title: Marketplace Purchase type: object properties: @@ -145143,7 +145178,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *712 + repository: *723 sender: *4 required: - action @@ -145223,10 +145258,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: *737 - organization: *711 + enterprise: *720 + installation: *721 + marketplace_purchase: *748 + organization: *722 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -145309,7 +145344,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *712 + repository: *723 sender: *4 required: - action @@ -145391,10 +145426,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: *737 - organization: *711 + enterprise: *720 + installation: *721 + marketplace_purchase: *748 + organization: *722 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -145476,7 +145511,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *712 + repository: *723 sender: *4 required: - action @@ -145557,8 +145592,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 marketplace_purchase: title: Marketplace Purchase type: object @@ -145640,9 +145675,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *711 - previous_marketplace_purchase: *738 - repository: *712 + organization: *722 + previous_marketplace_purchase: *749 + repository: *723 sender: *4 required: - action @@ -145722,12 +145757,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *709 - installation: *710 - marketplace_purchase: *737 - organization: *711 - previous_marketplace_purchase: *738 - repository: *712 + enterprise: *720 + installation: *721 + marketplace_purchase: *748 + organization: *722 + previous_marketplace_purchase: *749 + repository: *723 sender: *4 required: - action @@ -145829,11 +145864,11 @@ x-webhooks: type: string required: - to - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 sender: *4 required: - action @@ -145933,11 +145968,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 sender: *4 required: - action @@ -146016,11 +146051,11 @@ x-webhooks: type: string enum: - removed - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 sender: *4 required: - action @@ -146098,11 +146133,11 @@ x-webhooks: type: string enum: - added - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 scope: description: The scope of the membership. Currently, can only be `team`. @@ -146178,7 +146213,7 @@ x-webhooks: required: - login - id - team: &739 + team: &750 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -146401,11 +146436,11 @@ x-webhooks: type: string enum: - removed - enterprise: *709 - installation: *710 - member: *729 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + member: *740 + organization: *722 + repository: *723 scope: description: The scope of the membership. Currently, can only be `team`. @@ -146482,7 +146517,7 @@ x-webhooks: required: - login - id - team: *739 + team: *750 required: - action - scope @@ -146564,8 +146599,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *710 - merge_group: &741 + installation: *721 + merge_group: &752 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -146584,15 +146619,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *740 + head_commit: *751 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -146678,10 +146713,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *710 - merge_group: *741 - organization: *711 - repository: *712 + installation: *721 + merge_group: *752 + organization: *722 + repository: *723 sender: *4 required: - action @@ -146754,7 +146789,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 + enterprise: *720 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -146863,16 +146898,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *710 - organization: *711 + installation: *721 + organization: *722 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *753 + required: *754 nullable: true sender: *4 required: @@ -146953,11 +146988,11 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 - milestone: *734 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + milestone: *745 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147036,9 +147071,9 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - milestone: &744 + enterprise: *720 + installation: *721 + milestone: &755 title: Milestone description: A collection of related issues and pull requests. type: object @@ -147175,8 +147210,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147255,11 +147290,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - milestone: *734 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + milestone: *745 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147369,11 +147404,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - milestone: *734 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + milestone: *745 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147453,11 +147488,11 @@ x-webhooks: type: string enum: - opened - enterprise: *709 - installation: *710 - milestone: *744 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + milestone: *755 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147536,11 +147571,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *729 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + blocked_user: *740 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147619,11 +147654,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *729 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + blocked_user: *740 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147702,9 +147737,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - membership: &745 + enterprise: *720 + installation: *721 + membership: &756 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -147811,8 +147846,8 @@ x-webhooks: - role - organization_url - user - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147890,11 +147925,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *709 - installation: *710 - membership: *745 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + membership: *756 + organization: *722 + repository: *723 sender: *4 required: - action @@ -147973,8 +148008,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -148090,10 +148125,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 - user: *729 + user: *740 required: - action - invitation @@ -148171,11 +148206,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *709 - installation: *710 - membership: *745 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + membership: *756 + organization: *722 + repository: *723 sender: *4 required: - action @@ -148262,11 +148297,11 @@ x-webhooks: properties: from: type: string - enterprise: *709 - installation: *710 - membership: *745 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + membership: *756 + organization: *722 + repository: *723 sender: *4 required: - action @@ -148342,9 +148377,9 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 package: description: Information about the package. type: object @@ -148843,7 +148878,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &746 + items: &757 title: Ruby Gems metadata type: object properties: @@ -148938,7 +148973,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *723 sender: *4 required: - action @@ -149014,9 +149049,9 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 package: description: Information about the package. type: object @@ -149369,7 +149404,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *746 + items: *757 source_url: type: string format: uri @@ -149439,7 +149474,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *723 sender: *4 required: - action @@ -149616,12 +149651,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *709 + enterprise: *720 id: type: integer - installation: *710 - organization: *711 - repository: *712 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - id @@ -149698,7 +149733,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &747 + personal_access_token_request: &758 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -149844,10 +149879,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *709 - organization: *711 + enterprise: *720 + organization: *722 sender: *4 - installation: *710 + installation: *721 required: - action - personal_access_token_request @@ -149924,11 +149959,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *747 - enterprise: *709 - organization: *711 + personal_access_token_request: *758 + enterprise: *720 + organization: *722 sender: *4 - installation: *710 + installation: *721 required: - action - personal_access_token_request @@ -150004,11 +150039,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *747 - enterprise: *709 - organization: *711 + personal_access_token_request: *758 + enterprise: *720 + organization: *722 sender: *4 - installation: *710 + installation: *721 required: - action - personal_access_token_request @@ -150083,11 +150118,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *747 - organization: *711 - enterprise: *709 + personal_access_token_request: *758 + organization: *722 + enterprise: *720 sender: *4 - installation: *710 + installation: *721 required: - action - personal_access_token_request @@ -150192,7 +150227,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *748 + last_response: *759 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -150224,8 +150259,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 zen: description: Random string of GitHub zen. @@ -150470,10 +150505,10 @@ x-webhooks: - from required: - note - enterprise: *709 - installation: *710 - organization: *711 - project_card: &749 + enterprise: *720 + installation: *721 + organization: *722 + project_card: &760 title: Project Card type: object properties: @@ -150592,7 +150627,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *712 + repository: *723 sender: *4 required: - action @@ -150673,11 +150708,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - project_card: *749 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + project_card: *760 + repository: *723 sender: *4 required: - action @@ -150757,9 +150792,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 project_card: title: Project Card type: object @@ -150887,8 +150922,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *753 + required: *754 nullable: true sender: *4 required: @@ -150982,11 +151017,11 @@ x-webhooks: - from required: - note - enterprise: *709 - installation: *710 - organization: *711 - project_card: *749 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + project_card: *760 + repository: *723 sender: *4 required: - action @@ -151080,9 +151115,9 @@ x-webhooks: - from required: - column_id - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 project_card: allOf: - title: Project Card @@ -151272,7 +151307,7 @@ x-webhooks: type: string required: - after_id - repository: *712 + repository: *723 sender: *4 required: - action @@ -151352,10 +151387,10 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 - organization: *711 - project: &751 + enterprise: *720 + installation: *721 + organization: *722 + project: &762 title: Project type: object properties: @@ -151479,7 +151514,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *712 + repository: *723 sender: *4 required: - action @@ -151559,10 +151594,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - project_column: &750 + enterprise: *720 + installation: *721 + organization: *722 + project_column: &761 title: Project Column type: object properties: @@ -151601,7 +151636,7 @@ x-webhooks: - name - created_at - updated_at - repository: *712 + repository: *723 sender: *4 required: - action @@ -151680,18 +151715,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - project_column: *750 + enterprise: *720 + installation: *721 + organization: *722 + project_column: *761 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *753 + required: *754 nullable: true sender: *4 required: @@ -151781,11 +151816,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - project_column: *750 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + project_column: *761 + repository: *723 sender: *4 required: - action @@ -151865,11 +151900,11 @@ x-webhooks: type: string enum: - moved - enterprise: *709 - installation: *710 - organization: *711 - project_column: *750 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + project_column: *761 + repository: *723 sender: *4 required: - action @@ -151949,11 +151984,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - project: *751 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + project: *762 + repository: *723 sender: *4 required: - action @@ -152033,18 +152068,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - project: *751 + enterprise: *720 + installation: *721 + organization: *722 + project: *762 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *742 - required: *743 + properties: *753 + required: *754 nullable: true sender: *4 required: @@ -152146,11 +152181,11 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - project: *751 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + project: *762 + repository: *723 sender: *4 required: - action @@ -152229,11 +152264,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *709 - installation: *710 - organization: *711 - project: *751 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + project: *762 + repository: *723 sender: *4 required: - action @@ -152314,9 +152349,9 @@ x-webhooks: type: string enum: - closed - installation: *710 - organization: *711 - projects_v2: *253 + installation: *721 + organization: *722 + projects_v2: *259 sender: *4 required: - action @@ -152397,9 +152432,9 @@ x-webhooks: type: string enum: - created - installation: *710 - organization: *711 - projects_v2: *253 + installation: *721 + organization: *722 + projects_v2: *259 sender: *4 required: - action @@ -152480,9 +152515,9 @@ x-webhooks: type: string enum: - deleted - installation: *710 - organization: *711 - projects_v2: *253 + installation: *721 + organization: *722 + projects_v2: *259 sender: *4 required: - action @@ -152599,9 +152634,9 @@ x-webhooks: type: string to: type: string - installation: *710 - organization: *711 - projects_v2: *253 + installation: *721 + organization: *722 + projects_v2: *259 sender: *4 required: - action @@ -152684,7 +152719,7 @@ x-webhooks: type: string enum: - archived - changes: &755 + changes: &766 type: object properties: archived_at: @@ -152698,9 +152733,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *710 - organization: *711 - projects_v2_item: &752 + installation: *721 + organization: *722 + projects_v2_item: &763 title: Projects v2 Item description: An item belonging to a project type: object @@ -152718,7 +152753,7 @@ x-webhooks: type: string description: The node ID of the content represented by this item. - content_type: *260 + content_type: *266 creator: *4 created_at: type: string @@ -152835,9 +152870,9 @@ x-webhooks: nullable: true to: type: string - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *721 + organization: *722 + projects_v2_item: *763 sender: *4 required: - action @@ -152919,9 +152954,9 @@ x-webhooks: type: string enum: - created - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *721 + organization: *722 + projects_v2_item: *763 sender: *4 required: - action @@ -153002,9 +153037,9 @@ x-webhooks: type: string enum: - deleted - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *721 + organization: *722 + projects_v2_item: *763 sender: *4 required: - action @@ -153110,7 +153145,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &753 + - &764 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -153132,7 +153167,7 @@ x-webhooks: required: - id - name - - &754 + - &765 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -153166,8 +153201,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *753 - - *754 + - *764 + - *765 required: - field_value - type: object @@ -153183,9 +153218,9 @@ x-webhooks: nullable: true required: - body - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *721 + organization: *722 + projects_v2_item: *763 sender: *4 required: - action @@ -153280,9 +153315,9 @@ x-webhooks: to: type: string nullable: true - installation: *710 - organization: *711 - projects_v2_item: *752 + installation: *721 + organization: *722 + projects_v2_item: *763 sender: *4 required: - action @@ -153365,10 +153400,10 @@ x-webhooks: type: string enum: - restored - changes: *755 - installation: *710 - organization: *711 - projects_v2_item: *752 + changes: *766 + installation: *721 + organization: *722 + projects_v2_item: *763 sender: *4 required: - action @@ -153450,9 +153485,9 @@ x-webhooks: type: string enum: - reopened - installation: *710 - organization: *711 - projects_v2: *253 + installation: *721 + organization: *722 + projects_v2: *259 sender: *4 required: - action @@ -153533,14 +153568,14 @@ x-webhooks: type: string enum: - created - installation: *710 - organization: *711 - projects_v2_status_update: &758 + installation: *721 + organization: *722 + projects_v2_status_update: &769 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *756 - required: *757 + properties: *767 + required: *768 sender: *4 required: - action @@ -153621,9 +153656,9 @@ x-webhooks: type: string enum: - deleted - installation: *710 - organization: *711 - projects_v2_status_update: *758 + installation: *721 + organization: *722 + projects_v2_status_update: *769 sender: *4 required: - action @@ -153759,9 +153794,9 @@ x-webhooks: type: string format: date nullable: true - installation: *710 - organization: *711 - projects_v2_status_update: *758 + installation: *721 + organization: *722 + projects_v2_status_update: *769 sender: *4 required: - action @@ -153832,10 +153867,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - repository @@ -153912,13 +153947,13 @@ x-webhooks: type: string enum: - assigned - assignee: *729 - enterprise: *709 - installation: *710 - number: &759 + assignee: *740 + enterprise: *720 + installation: *721 + number: &770 description: The pull request number. type: integer - organization: *711 + organization: *722 pull_request: title: Pull Request type: object @@ -156201,7 +156236,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 sender: *4 required: - action @@ -156283,11 +156318,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 number: type: integer - organization: *711 + organization: *722 pull_request: title: Pull Request type: object @@ -158565,7 +158600,7 @@ x-webhooks: - draft reason: type: string - repository: *712 + repository: *723 sender: *4 required: - action @@ -158647,11 +158682,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 number: type: integer - organization: *711 + organization: *722 pull_request: title: Pull Request type: object @@ -160929,7 +160964,7 @@ x-webhooks: - draft reason: type: string - repository: *712 + repository: *723 sender: *4 required: - action @@ -161011,13 +161046,13 @@ x-webhooks: type: string enum: - closed - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: &760 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 + pull_request: &771 allOf: - - *571 + - *575 - type: object properties: allow_auto_merge: @@ -161079,7 +161114,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *712 + repository: *723 sender: *4 required: - action @@ -161160,12 +161195,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 + pull_request: *771 + repository: *723 sender: *4 required: - action @@ -161245,11 +161280,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *709 - milestone: *553 - number: *759 - organization: *711 - pull_request: &761 + enterprise: *720 + milestone: *557 + number: *770 + organization: *722 + pull_request: &772 title: Pull Request type: object properties: @@ -163512,7 +163547,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 sender: *4 required: - action @@ -163591,11 +163626,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 number: type: integer - organization: *711 + organization: *722 pull_request: title: Pull Request type: object @@ -165877,7 +165912,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *712 + repository: *723 sender: *4 required: - action @@ -166001,12 +166036,12 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 + pull_request: *771 + repository: *723 sender: *4 required: - action @@ -166086,11 +166121,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 number: type: integer - organization: *711 + organization: *722 pull_request: title: Pull Request type: object @@ -168357,7 +168392,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 sender: *4 required: - action @@ -168437,11 +168472,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *709 - installation: *710 - label: *728 - number: *759 - organization: *711 + enterprise: *720 + installation: *721 + label: *739 + number: *770 + organization: *722 pull_request: title: Pull Request type: object @@ -170723,7 +170758,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 sender: *4 required: - action @@ -170804,10 +170839,10 @@ x-webhooks: type: string enum: - locked - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 pull_request: title: Pull Request type: object @@ -173087,7 +173122,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 sender: *4 required: - action @@ -173167,12 +173202,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *709 - milestone: *553 - number: *759 - organization: *711 - pull_request: *761 - repository: *712 + enterprise: *720 + milestone: *557 + number: *770 + organization: *722 + pull_request: *772 + repository: *723 sender: *4 required: - action @@ -173251,12 +173286,12 @@ x-webhooks: type: string enum: - opened - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 + pull_request: *771 + repository: *723 sender: *4 required: - action @@ -173337,12 +173372,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 + pull_request: *771 + repository: *723 sender: *4 required: - action @@ -173422,12 +173457,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *709 - installation: *710 - number: *759 - organization: *711 - pull_request: *760 - repository: *712 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 + pull_request: *771 + repository: *723 sender: *4 required: - action @@ -173793,9 +173828,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 pull_request: type: object properties: @@ -175965,7 +176000,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *712 + repository: *723 sender: *4 required: - action @@ -176045,7 +176080,7 @@ x-webhooks: type: string enum: - deleted - comment: &763 + comment: &774 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -176330,9 +176365,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 pull_request: type: object properties: @@ -178490,7 +178525,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *712 + repository: *723 sender: *4 required: - action @@ -178570,11 +178605,11 @@ x-webhooks: type: string enum: - edited - changes: *762 - comment: *763 - enterprise: *709 - installation: *710 - organization: *711 + changes: *773 + comment: *774 + enterprise: *720 + installation: *721 + organization: *722 pull_request: type: object properties: @@ -180735,7 +180770,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *712 + repository: *723 sender: *4 required: - action @@ -180816,9 +180851,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -182991,7 +183026,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 + repository: *723 review: description: The review that was affected. type: object @@ -183238,9 +183273,9 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -185294,8 +185329,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 - review: &764 + repository: *723 + review: &775 description: The review that was affected. type: object properties: @@ -185528,12 +185563,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *711 + organization: *722 pull_request: title: Pull Request type: object @@ -187816,7 +187851,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 requested_reviewer: title: User type: object @@ -187900,12 +187935,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *711 + organization: *722 pull_request: title: Pull Request type: object @@ -190195,7 +190230,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 requested_team: title: Team description: Groups of organization members that gives permissions @@ -190387,12 +190422,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *711 + organization: *722 pull_request: title: Pull Request type: object @@ -192677,7 +192712,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 requested_reviewer: title: User type: object @@ -192762,12 +192797,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *709 - installation: *710 + enterprise: *720 + installation: *721 number: description: The pull request number. type: integer - organization: *711 + organization: *722 pull_request: title: Pull Request type: object @@ -195043,7 +195078,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 requested_team: title: Team description: Groups of organization members that gives permissions @@ -195224,9 +195259,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -197401,8 +197436,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 - review: *764 + repository: *723 + review: *775 sender: *4 required: - action @@ -197482,9 +197517,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -199554,7 +199589,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 + repository: *723 sender: *4 thread: type: object @@ -199941,9 +199976,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 pull_request: title: Simple Pull Request type: object @@ -201999,7 +202034,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *712 + repository: *723 sender: *4 thread: type: object @@ -202389,10 +202424,10 @@ x-webhooks: type: string before: type: string - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 pull_request: title: Pull Request type: object @@ -204663,7 +204698,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 sender: *4 required: - action @@ -204745,11 +204780,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *765 - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + assignee: *776 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 pull_request: title: Pull Request type: object @@ -207032,7 +207067,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 sender: *4 required: - action @@ -207111,11 +207146,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *709 - installation: *710 - label: *728 - number: *759 - organization: *711 + enterprise: *720 + installation: *721 + label: *739 + number: *770 + organization: *722 pull_request: title: Pull Request type: object @@ -209388,7 +209423,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 sender: *4 required: - action @@ -209469,10 +209504,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *709 - installation: *710 - number: *759 - organization: *711 + enterprise: *720 + installation: *721 + number: *770 + organization: *722 pull_request: title: Pull Request type: object @@ -211737,7 +211772,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *712 + repository: *723 sender: *4 required: - action @@ -211937,7 +211972,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *709 + enterprise: *720 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -212029,8 +212064,8 @@ x-webhooks: - url - author - committer - installation: *710 - organization: *711 + installation: *721 + organization: *722 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -212605,9 +212640,9 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 registry_package: type: object properties: @@ -213053,7 +213088,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *746 + items: *757 summary: type: string tag_name: @@ -213107,7 +213142,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *723 sender: *4 required: - action @@ -213185,9 +213220,9 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 registry_package: type: object properties: @@ -213495,7 +213530,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *746 + items: *757 summary: type: string tag_name: @@ -213544,7 +213579,7 @@ x-webhooks: - owner - package_version - registry - repository: *712 + repository: *723 sender: *4 required: - action @@ -213621,10 +213656,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - release: &766 + enterprise: *720 + installation: *721 + organization: *722 + release: &777 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -213942,7 +213977,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *712 + repository: *723 sender: *4 required: - action @@ -214019,11 +214054,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - release: *766 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + release: *777 + repository: *723 sender: *4 required: - action @@ -214140,11 +214175,11 @@ x-webhooks: type: boolean required: - to - enterprise: *709 - installation: *710 - organization: *711 - release: *766 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + release: *777 + repository: *723 sender: *4 required: - action @@ -214222,9 +214257,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -214546,7 +214581,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *712 + repository: *723 sender: *4 required: - action @@ -214622,10 +214657,10 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 - release: &767 + enterprise: *720 + installation: *721 + organization: *722 + release: &778 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -214944,7 +214979,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *712 + repository: *723 sender: *4 required: - action @@ -215020,11 +215055,11 @@ x-webhooks: type: string enum: - released - enterprise: *709 - installation: *710 - organization: *711 - release: *766 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + release: *777 + repository: *723 sender: *4 required: - action @@ -215100,11 +215135,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *709 - installation: *710 - organization: *711 - release: *767 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + release: *778 + repository: *723 sender: *4 required: - action @@ -215180,11 +215215,11 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - repository_advisory: *635 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + repository_advisory: *639 sender: *4 required: - action @@ -215260,11 +215295,11 @@ x-webhooks: type: string enum: - reported - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - repository_advisory: *635 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + repository_advisory: *639 sender: *4 required: - action @@ -215340,10 +215375,10 @@ x-webhooks: type: string enum: - archived - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -215420,10 +215455,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -215501,10 +215536,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -215588,10 +215623,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -215703,10 +215738,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -215778,10 +215813,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 status: type: string @@ -215862,10 +215897,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -215942,10 +215977,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -216039,10 +216074,10 @@ x-webhooks: - name required: - repository - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -216122,11 +216157,11 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - repository_ruleset: *298 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + repository_ruleset: *305 sender: *4 required: - action @@ -216204,11 +216239,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - repository_ruleset: *298 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + repository_ruleset: *305 sender: *4 required: - action @@ -216286,11 +216321,11 @@ x-webhooks: type: string enum: - edited - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - repository_ruleset: *298 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + repository_ruleset: *305 changes: type: object properties: @@ -216309,16 +216344,16 @@ x-webhooks: properties: added: type: array - items: *273 + items: *279 deleted: type: array - items: *273 + items: *279 updated: type: array items: type: object properties: - condition: *273 + condition: *279 changes: type: object properties: @@ -216351,16 +216386,16 @@ x-webhooks: properties: added: type: array - items: *592 + items: *595 deleted: type: array - items: *592 + items: *595 updated: type: array items: type: object properties: - rule: *592 + rule: *595 changes: type: object properties: @@ -216594,10 +216629,10 @@ x-webhooks: - from required: - owner - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -216675,10 +216710,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -216756,7 +216791,7 @@ x-webhooks: type: string enum: - create - alert: &768 + alert: &779 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -216877,10 +216912,10 @@ x-webhooks: type: string enum: - open - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -217086,10 +217121,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -217167,11 +217202,11 @@ x-webhooks: type: string enum: - reopen - alert: *768 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *779 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -217370,10 +217405,10 @@ x-webhooks: enum: - fixed - open - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -217391,7 +217426,7 @@ x-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. @@ -217399,8 +217434,8 @@ x-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: @@ -217444,18 +217479,18 @@ x-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: &769 + - assigned + alert: &780 type: object properties: - number: *161 - created_at: *162 + number: *167 + created_at: *168 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -217463,8 +217498,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *164 - html_url: *165 + url: *170 + html_url: *171 locations_url: type: string format: uri @@ -217569,10 +217604,93 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + assignee: *4 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + 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: *780 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -217653,11 +217771,11 @@ x-webhooks: type: string enum: - created - alert: *769 - installation: *710 - location: *770 - organization: *711 - repository: *712 + alert: *780 + installation: *721 + location: *781 + organization: *722 + repository: *723 sender: *4 required: - location @@ -217895,11 +218013,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *780 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -217977,11 +218095,11 @@ x-webhooks: type: string enum: - reopened - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *780 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -218059,11 +218177,94 @@ x-webhooks: type: string enum: - resolved - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *780 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + 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: *780 + assignee: *4 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -218141,11 +218342,11 @@ x-webhooks: type: string enum: - validated - alert: *769 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + alert: *780 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -218271,10 +218472,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *712 - enterprise: *709 - installation: *710 - organization: *711 + repository: *723 + enterprise: *720 + installation: *721 + organization: *722 sender: *4 required: - action @@ -218352,11 +218553,11 @@ x-webhooks: type: string enum: - published - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - security_advisory: &771 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + security_advisory: &782 description: The details of the security advisory, including summary, description, and severity. type: object @@ -218372,7 +218573,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *50 + cvss_severities: *54 cwes: type: array items: @@ -218539,11 +218740,11 @@ x-webhooks: type: string enum: - updated - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 - security_advisory: *771 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 + security_advisory: *782 sender: *4 required: - action @@ -218616,10 +218817,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -218636,7 +218837,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *50 + cvss_severities: *54 cwes: type: array items: @@ -218803,11 +219004,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *272 - enterprise: *709 - installation: *710 - organization: *711 - repository: *333 + security_and_analysis: *278 + enterprise: *720 + installation: *721 + organization: *722 + repository: *335 sender: *4 required: - changes @@ -218885,12 +219086,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: &772 + sponsorship: &783 type: object properties: created_at: @@ -219191,12 +219392,12 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *772 + sponsorship: *783 required: - action - sponsorship @@ -219284,12 +219485,12 @@ x-webhooks: type: string required: - from - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *772 + sponsorship: *783 required: - action - changes @@ -219366,17 +219567,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &773 + effective_date: &784 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: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *772 + sponsorship: *783 required: - action - sponsorship @@ -219450,7 +219651,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &774 + changes: &785 type: object properties: tier: @@ -219494,13 +219695,13 @@ x-webhooks: - from required: - tier - effective_date: *773 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + effective_date: *784 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *772 + sponsorship: *783 required: - action - changes @@ -219577,13 +219778,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *774 - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + changes: *785 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - sponsorship: *772 + sponsorship: *783 required: - action - changes @@ -219657,10 +219858,10 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -219743,10 +219944,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -220166,15 +220367,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *709 + enterprise: *720 id: description: The unique identifier of the status. type: integer - installation: *710 + installation: *721 name: type: string - organization: *711 - repository: *712 + organization: *722 + repository: *723 sender: *4 sha: description: The Commit SHA. @@ -220283,15 +220484,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *82 - parent_issue_repo: *66 + parent_issue: *86 + parent_issue_repo: *70 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *82 - installation: *710 - organization: *711 - repository: *712 + sub_issue: *86 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -220375,15 +220576,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *82 - parent_issue_repo: *66 + parent_issue: *86 + parent_issue_repo: *70 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *82 - installation: *710 - organization: *711 - repository: *712 + sub_issue: *86 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -220467,15 +220668,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *82 - sub_issue_repo: *66 + sub_issue: *86 + sub_issue_repo: *70 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *82 - installation: *710 - organization: *711 - repository: *712 + parent_issue: *86 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -220559,15 +220760,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *82 - sub_issue_repo: *66 + sub_issue: *86 + sub_issue_repo: *70 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *82 - installation: *710 - organization: *711 - repository: *712 + parent_issue: *86 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -220644,12 +220845,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - team: &775 + team: &786 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -220872,9 +221073,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -221332,7 +221533,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *786 required: - action - team @@ -221408,9 +221609,9 @@ x-webhooks: type: string enum: - created - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -221868,7 +222069,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *786 required: - action - team @@ -221945,9 +222146,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -222405,7 +222606,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *786 required: - action - team @@ -222549,9 +222750,9 @@ x-webhooks: - from required: - permissions - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -223009,7 +223210,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *786 required: - action - changes @@ -223087,9 +223288,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *709 - installation: *710 - organization: *711 + enterprise: *720 + installation: *721 + organization: *722 repository: title: Repository description: A git repository @@ -223547,7 +223748,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *775 + team: *786 required: - action - team @@ -223623,10 +223824,10 @@ x-webhooks: type: string enum: - started - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 required: - action @@ -223699,16 +223900,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *709 + enterprise: *720 inputs: type: object nullable: true additionalProperties: true - installation: *710 - organization: *711 + installation: *721 + organization: *722 ref: type: string - repository: *712 + repository: *723 sender: *4 workflow: type: string @@ -223790,10 +223991,10 @@ x-webhooks: type: string enum: - completed - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: allOf: @@ -224030,7 +224231,7 @@ x-webhooks: type: string required: - conclusion - deployment: *484 + deployment: *488 required: - action - repository @@ -224109,10 +224310,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: allOf: @@ -224372,7 +224573,7 @@ x-webhooks: required: - status - steps - deployment: *484 + deployment: *488 required: - action - repository @@ -224451,10 +224652,10 @@ x-webhooks: type: string enum: - queued - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: type: object @@ -224589,7 +224790,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *484 + deployment: *488 required: - action - repository @@ -224668,10 +224869,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 workflow_job: type: object @@ -224807,7 +225008,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *484 + deployment: *488 required: - action - repository @@ -224887,12 +225088,12 @@ x-webhooks: type: string enum: - completed - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *724 + workflow: *735 workflow_run: title: Workflow Run type: object @@ -225891,12 +226092,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *724 + workflow: *735 workflow_run: title: Workflow Run type: object @@ -226880,12 +227081,12 @@ x-webhooks: type: string enum: - requested - enterprise: *709 - installation: *710 - organization: *711 - repository: *712 + enterprise: *720 + installation: *721 + organization: *722 + repository: *723 sender: *4 - workflow: *724 + workflow: *735 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index cf7f65190..3a847bd24 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.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." @@ -4734,6 +4730,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.", @@ -5735,6 +5739,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.", @@ -6590,6 +6602,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.", @@ -7076,6 +7096,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.", @@ -9117,6 +9145,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.", @@ -10169,6 +10205,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.", @@ -11138,6 +11182,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.", @@ -11818,6 +11870,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.", @@ -17501,6 +17561,572 @@ } } }, + "/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/enterprise-cloud@latest//rest/actions/cache#get-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" + } + } + ], + "responses": { + "200": { + "description": "Response", + "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", + "example": 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 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/enterprise-cloud@latest//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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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/enterprise-cloud@latest//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", + "example": 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/enterprise-cloud@latest//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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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/usage": { "get": { "summary": "Get GitHub Actions cache usage for an enterprise", @@ -27409,6 +28035,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.", @@ -28205,6 +28839,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.", @@ -29157,6 +29799,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.", @@ -30500,6 +31150,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.", @@ -52734,6 +53392,35 @@ ] } } + }, + { + "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." + } + } + } + } } ] } @@ -57356,6 +58043,35 @@ ] } } + }, + { + "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." + } + } + } + } } ] } @@ -59354,6 +60070,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.", @@ -61888,6 +62627,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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": { @@ -61977,6 +62757,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": [ @@ -63078,226 +63862,20 @@ "update-budget": { "value": { "message": "Budget successfully updated.", - "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" - } - } - } - } - } - }, - "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", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "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" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Budget not found or feature not enabled", - "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" - } - } - }, - "examples": { - "budget-not-found": { - "value": { - "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - }, - "feature-not-enabled": { - "value": { - "message": "Not Found", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } + "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" + ] } } } @@ -63306,146 +63884,367 @@ } } }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - }, - "examples": { - "server-error": { - "value": { - "message": "Unable to retrieve budget.", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "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" - } - } - }, - "examples": { - "server-error": { - "value": { - "message": "Unable to update budget.", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "billing", - "subcategory": "budgets" - } - }, - "delete": { - "summary": "Delete a budget", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID. The authenticated user must be an enterprise admin.", - "tags": [ - "billing" - ], - "operationId": "billing/delete-budget", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#delete-a-budget" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "budget_id", - "description": "The ID corresponding to the budget.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response when deleting a budget", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "A message indicating the result of the deletion operation" - }, - "id": { - "type": "string", - "description": "The ID of the deleted budget" - } - }, - "required": [ - "message", - "id" - ] - }, - "examples": { - "default": { - "value": { - "message": "Budget successfully deleted.", - "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" - } - } - } - } - } - }, + "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "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" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Budget not found or feature not enabled", + "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" + } + } + }, + "examples": { + "budget-not-found": { + "value": { + "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + }, + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to retrieve budget.", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "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" + } + } + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to update budget.", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "budgets" + } + }, + "delete": { + "summary": "Delete a budget", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID. The authenticated user must be an enterprise admin.", + "tags": [ + "billing" + ], + "operationId": "billing/delete-budget", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#delete-a-budget" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "budget_id", + "description": "The ID corresponding to the budget.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response when deleting a budget", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the deletion operation" + }, + "id": { + "type": "string", + "description": "The ID of the deleted budget" + } + }, + "required": [ + "message", + "id" + ] + }, + "examples": { + "default": { + "value": { + "message": "Budget successfully deleted.", + "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" + } + } + } + } + } + }, "400": { "description": "Bad Request", "content": { @@ -97479,6 +98278,572 @@ "deprecated": true } }, + "/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/enterprise-cloud@latest//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", + "example": 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/enterprise-cloud@latest//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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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/enterprise-cloud@latest//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", + "example": 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/enterprise-cloud@latest//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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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", @@ -151668,6 +153033,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.", @@ -152684,6 +154057,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.", @@ -188900,19 +190281,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/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-a-field-to-an-organization-owned-project" }, "parameters": [ { @@ -188924,15 +190303,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.", @@ -188943,9 +190313,262 @@ } } ], + "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": { @@ -189135,7 +190758,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", @@ -189145,37 +190801,509 @@ "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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/enterprise-cloud@latest//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": { + "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.", + "example": "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", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was last updated." + } + }, + "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": { @@ -211453,6 +213581,35 @@ ] } } + }, + { + "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." + } + } + } + } } ] } @@ -216115,6 +218272,35 @@ ] } } + }, + { + "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." + } + } + } + } } ] } @@ -218162,6 +220348,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.", @@ -235193,17 +237402,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/enterprise-cloud@latest//rest/teams/teams#list-team-projects" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -235251,42 +237460,28 @@ "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", + "example": 1296269 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "type": "string" - }, - "body": { "type": "string", - "nullable": true - }, - "number": { - "type": "integer" + "example": "Hello-World" }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -235410,55 +237605,550 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "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", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "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", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, "permissions": { "type": "object", "properties": { - "read": { + "admin": { + "type": "boolean" + }, + "maintain": { "type": "boolean" }, - "write": { + "push": { "type": "boolean" }, - "admin": { + "triage": { + "type": "boolean" + }, + "pull": { "type": "boolean" } + } + }, + "role_name": { + "type": "string", + "example": "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", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# 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", + "format": "uri", + "nullable": true + } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "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" + ] + } + } + }, + "secret_scanning_validity_checks": { + "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" ] } }, @@ -235466,17 +238156,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=", @@ -235496,1397 +238180,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/enterprise-cloud@latest//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", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "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/enterprise-cloud@latest//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", - "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/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - }, - "nullable": true - }, - "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "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", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# 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", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "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" - ] - } - } - }, - "secret_scanning_validity_checks": { - "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_validity_checks": { - "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_validity_checks": { + "status": "disabled" + } } } ] @@ -238650,327 +240034,463 @@ "deprecated": true } }, - "/projects/columns/cards/{card_id}": { + "/rate_limit": { "get": { - "summary": "Get a project card", - "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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-card", + "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], + "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" - }, - "id": { - "description": "The project card's ID", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" - }, - "note": { - "type": "string", - "example": "Add payload for delete Project column", - "nullable": true - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", + "resources": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "core": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "graphql": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "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" + ] }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "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" + ] }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "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" + ] }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "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" + ] }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "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" + ] }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "scim": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "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" + ] }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "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" + ] }, - "type": { - "type": "string", - "example": "User" + "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" }, - "site_admin": { - "type": "boolean" + "remaining": { + "type": "integer" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "reset": { + "type": "integer" }, - "user_view_type": { - "type": "string", - "example": "public" + "used": { + "type": "integer" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "content_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" + "limit", + "remaining", + "reset", + "used" + ] } }, "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" + "rate", + "resources" ] }, "examples": { "default": { "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "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 + "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 + } }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" + "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" } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { + }, + "X-RateLimit-Remaining": { + "example": 4999, "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-Reset": { + "example": 1590701888, + "schema": { + "type": "integer", + "format": "timestamp" } } } }, + "304": { + "description": "Not modified" + }, "404": { "description": "Resource not found", "content": { @@ -238999,99 +240519,73 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an existing project card", - "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/enterprise-cloud@latest//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-card", + "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository" }, "parameters": [ { - "name": "card_id", - "description": "The unique identifier of the card.", + "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": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "note": { - "description": "The project card's note", - "example": "Update all gems", - "type": "string", - "nullable": true - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - } - } - }, - "examples": { - "default": { - "summary": "Change the note on the card", - "value": { - "note": "Add payload for delete Project column" - } - } - } + }, + { + "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 Card", - "description": "Project cards represent a scope of work.", + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" - }, "id": { - "description": "The project card's ID", - "example": 42, "type": "integer", - "format": "int64" + "format": "int64", + "example": 1296269 }, "node_id": { "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "note": { + "name": { "type": "string", - "example": "Add payload for delete Project column", - "nullable": true + "example": "Hello-World" }, - "creator": { + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -239213,2994 +240707,1194 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ] }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" + "private": { + "type": "boolean" }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true }, - "project_id": { - "type": "string" + "fork": { + "type": "boolean" }, - "column_url": { + "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "content_url": { + "archive_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "project_url": { + "assignees_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "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": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "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" + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "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" + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "documentation_url": { - "type": "string" + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project card", - "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-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "documentation_url": { - "type": "string" + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/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" + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, - "documentation_url": { - "type": "string" + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, - "url": { - "type": "string" + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "documentation_url": { - "type": "string" + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "url": { - "type": "string" + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/cards/{card_id}/moves": { - "post": { - "summary": "Move a project card", - "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-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", - "example": "bottom", - "type": "string", - "pattern": "^(?:top|bottom|after:\\d+)$" - }, - "column_id": { - "description": "The unique identifier of the column the card should be moved to", - "example": 42, - "type": "integer" - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the card to the bottom of the column", - "value": { - "column_id": 42, - "position": "bottom" - } - } - } - } - } - }, - "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": { - "type": "object", - "properties": { - "message": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "documentation_url": { - "type": "string" + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "resource": { - "type": "string" - }, - "field": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "documentation_url": { - "type": "string" + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "url": { - "type": "string" + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "503": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, - "message": { - "type": "string" + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "documentation_url": { - "type": "string" + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "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" + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - "documentation_url": { - "type": "string" + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "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/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column" - }, - "parameters": [ - { - "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": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { + "labels_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, - "project_url": { + "languages_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/120" + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, - "cards_url": { + "merges_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, - "node_id": { + "milestones_url": { "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" - }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, - "created_at": { + "notifications_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, - "updated_at": { + "pulls_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "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" - }, - "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" + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, - "url": { - "type": "string" + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" }, - "documentation_url": { - "type": "string" + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, - "url": { - "type": "string" + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{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 - }, - "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/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-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": { - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Rename the project column", - "value": { - "name": "To Do" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { + "subscribers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, - "project_url": { + "subscription_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/120" + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, - "cards_url": { + "tags_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" + "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, - "node_id": { + "teams_url": { "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, - "created_at": { + "clone_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" + "example": "https://github.com/octocat/Hello-World.git" }, - "updated_at": { + "mirror_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "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" + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true }, - "documentation_url": { - "type": "string" + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, - "url": { - "type": "string" + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true }, - "documentation_url": { - "type": "string" + "language": { + "type": "string", + "nullable": true }, - "url": { - "type": "string" + "forks_count": { + "type": "integer", + "example": 9 }, - "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/enterprise-cloud@latest//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" + "stargazers_count": { + "type": "integer", + "example": 80 }, - "documentation_url": { - "type": "string" + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "default_branch": { + "type": "string", + "example": "master" }, - "documentation_url": { - "type": "string" + "open_issues_count": { + "type": "integer", + "example": 0 }, - "url": { - "type": "string" + "is_template": { + "type": "boolean", + "example": true }, - "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}/cards": { - "get": { - "summary": "List project cards", - "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-cards", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "archived_state", - "description": "Filters the project cards that are returned by the card's state.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "archived", - "not_archived" - ], - "default": "not_archived" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" - }, - "id": { - "description": "The project card's ID", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" - }, - "note": { - "type": "string", - "example": "Add payload for delete Project column", - "nullable": true - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { + "topics": { + "type": "array", + "items": { "type": "string" }, - "column_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "content_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - } + "example": [ + "octocat", + "atom", + "electron", + "API" + ] }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "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": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - ] - } - } - } - }, - "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" + "has_issues": { + "type": "boolean", + "example": true }, - "documentation_url": { - "type": "string" + "has_projects": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "has_wiki": { + "type": "boolean", + "example": true }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "has_pages": { + "type": "boolean" }, - "documentation_url": { - "type": "string" + "has_downloads": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "has_discussions": { + "type": "boolean", + "example": true }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create a project card", - "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/create-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card" - }, - "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": { - "oneOf": [ - { - "type": "object", - "properties": { - "note": { - "description": "The project card's note", - "example": "Update all gems", - "type": "string", - "nullable": true - } + "archived": { + "type": "boolean" }, - "required": [ - "note" - ] - }, - { - "type": "object", - "properties": { - "content_id": { - "description": "The unique identifier of the content associated with the card", - "example": 42, - "type": "integer" - }, - "content_type": { - "description": "The piece of content associated with the card", - "example": "PullRequest", - "type": "string" - } + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." }, - "required": [ - "content_id", - "content_type" - ] - } - ] - }, - "examples": { - "default": { - "summary": "Create a new card", - "value": { - "note": "Add payload for delete Project column" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { + "visibility": { + "description": "The repository visibility: public, private, or internal.", "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" + "example": "public" }, - "id": { - "description": "The project card's ID", - "example": 42, - "type": "integer", - "format": "int64" + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" }, - "node_id": { + "created_at": { "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" + "format": "date-time", + "example": "2011-01-26T19:01:12Z" }, - "note": { + "updated_at": { "type": "string", - "example": "Add payload for delete Project column", - "nullable": true + "format": "date-time", + "example": "2011-01-26T19:14:43Z" }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", + "permissions": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "admin": { + "type": "boolean" }, - "email": { - "nullable": true, - "type": "string" + "maintain": { + "type": "boolean" }, - "login": { - "type": "string", - "example": "octocat" + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" }, + "pull": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "allow_rebase_merge": { + "type": "boolean", + "example": true + }, + "template_repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "format": "int64", - "example": 1 + "format": "int64" }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "avatar_url": { + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "https://github.com/octocat/Hello-World" }, - "gravatar_id": { + "description": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", + "example": "This your first repo!", "nullable": true }, + "fork": { + "type": "boolean" + }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "html_url": { + "archive_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "followers_url": { + "assignees_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "following_url": { + "blobs_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "gists_url": { + "branches_url": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "starred_url": { + "collaborators_url": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "subscriptions_url": { + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "organizations_url": { + "deployments_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "repos_url": { + "downloads_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "received_events_url": { + "forks_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "type": { + "git_commits_url": { "type": "string", - "example": "User" + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "site_admin": { - "type": "boolean" + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "starred_at": { + "git_tags_url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - "user_view_type": { + "git_url": { "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "content_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "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": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - } - } - } - } - }, - "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", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "example": "git:github.com/octocat/Hello-World.git" }, - "documentation_url": { - "type": "string" + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - }, - { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - "documentation_url": { - "type": "string" + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ] - } - } - } - }, - "503": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { "type": "string" } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "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/enterprise-cloud@latest//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.", - "example": "last", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$" - } - }, - "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" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "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 - } - }, - "/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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "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" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "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 - } - }, - "/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/enterprise-cloud@latest//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", - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "example": "write", - "type": "string" - } - }, - "nullable": true - }, - "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" - }, - "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" + }, + "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" + ], + "nullable": true }, - "documentation_url": { - "type": "string" + "temp_clone_token": { + "type": "string", + "nullable": true }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "allow_squash_merge": { + "type": "boolean", + "example": true }, - "documentation_url": { - "type": "string" + "allow_auto_merge": { + "type": "boolean", + "example": false }, - "url": { - "type": "string" + "delete_branch_on_merge": { + "type": "boolean", + "example": false }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "allow_merge_commit": { + "type": "boolean", + "example": true }, - "documentation_url": { - "type": "string" + "allow_update_branch": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "use_squash_pr_title_as_default": { + "type": "boolean", + "example": false }, - "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/enterprise-cloud@latest//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" + "squash_merge_commit_title": { + "type": "string", + "example": "PR_TITLE", + "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)." }, - "documentation_url": { - "type": "string" + "squash_merge_commit_message": { + "type": "string", + "example": "PR_BODY", + "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." }, - "url": { - "type": "string" + "merge_commit_title": { + "type": "string", + "example": "PR_TITLE", + "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)." }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "merge_commit_message": { + "type": "string", + "example": "PR_BODY", + "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." }, - "documentation_url": { - "type": "string" + "allow_forking": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "web_commit_signoff_required": { + "type": "boolean", + "example": false }, - "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" + "subscribers_count": { + "type": "integer", + "example": 42 }, - "documentation_url": { - "type": "string" + "network_count": { + "type": "integer", + "example": 0 }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" } - } - } - } - } - } - } - }, - "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 - } - }, - "/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/enterprise-cloud@latest//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" + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true }, - "user": { + "organization": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -242324,2406 +242018,223 @@ "url" ], "nullable": true - } - }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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": { + "parent": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { - "core": { - "title": "Rate Limit", + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" + "key": { + "type": "string", + "example": "mit" }, - "reset": { - "type": "integer" + "name": { + "type": "string", + "example": "MIT License" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "graphql": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" }, - "remaining": { - "type": "integer" + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" }, - "reset": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" }, - "used": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "limit", - "remaining", - "reset", - "used" - ] + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true }, - "search": { - "title": "Rate Limit", + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "limit": { - "type": "integer" + "admin": { + "type": "boolean" }, - "remaining": { - "type": "integer" + "pull": { + "type": "boolean" }, - "reset": { - "type": "integer" + "triage": { + "type": "boolean" }, - "used": { - "type": "integer" + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, "required": [ - "limit", - "remaining", - "reset", - "used" + "admin", + "pull", + "push" ] }, - "code_search": { - "title": "Rate Limit", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "limit": { - "type": "integer" + "name": { + "nullable": true, + "type": "string" }, - "remaining": { - "type": "integer" + "email": { + "nullable": true, + "type": "string" }, - "reset": { - "type": "integer" + "login": { + "type": "string", + "example": "octocat" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "source_import": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "remaining": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "reset": { - "type": "integer" + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "integration_manifest": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "remaining": { - "type": "integer" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "reset": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_upload": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "remaining": { - "type": "integer" + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "reset": { - "type": "integer" + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "actions_runner_registration": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "remaining": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "reset": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "scim": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, - "remaining": { - "type": "integer" + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "reset": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_snapshots": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "type": { + "type": "string", + "example": "User" }, - "remaining": { - "type": "integer" + "site_admin": { + "type": "boolean" }, - "reset": { - "type": "integer" + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" }, - "used": { - "type": "integer" + "user_view_type": { + "type": "string", + "example": "public" } }, "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 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", - "example": 108 - }, - "default_branch": { - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "example": true - }, - "has_projects": { - "type": "boolean", - "example": true - }, - "has_wiki": { - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "example": true - }, - "has_discussions": { - "type": "boolean", - "example": 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", - "example": "public" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "example": true - }, - "template_repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 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", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": 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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "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" - ], - "nullable": true - }, - "temp_clone_token": { - "type": "string", - "nullable": true - }, - "allow_squash_merge": { - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "type": "boolean", - "example": false - }, - "allow_merge_commit": { - "type": "boolean", - "example": true - }, - "allow_update_branch": { - "type": "boolean", - "example": true - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "example": false - }, - "squash_merge_commit_title": { - "type": "string", - "example": "PR_TITLE", - "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", - "example": "PR_BODY", - "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", - "example": "PR_TITLE", - "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", - "example": "PR_BODY", - "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_forking": { - "type": "boolean", - "example": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "subscribers_count": { - "type": "integer", - "example": 42 - }, - "network_count": { - "type": "integer", - "example": 0 - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "parent": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "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": { @@ -251639,6 +249150,608 @@ } } }, + "/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/enterprise-cloud@latest//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", + "example": 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/enterprise-cloud@latest//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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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/enterprise-cloud@latest//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", + "example": 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/enterprise-cloud@latest//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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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", @@ -277562,6 +275675,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -277582,6 +275696,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -295780,6 +293895,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -295800,6 +293916,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -333647,6 +331764,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -333667,6 +331785,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -339401,6 +337520,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -339421,6 +337541,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -344754,6 +342875,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -344774,6 +342896,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345300,6 +343423,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345320,6 +343444,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345870,6 +343995,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345890,6 +344016,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -381848,6 +379975,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.", @@ -464232,6 +462367,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -464252,6 +462388,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -495105,6 +493242,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -495125,6 +493263,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -526189,6 +524328,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.", @@ -528429,7 +526591,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" @@ -528499,6 +526661,11 @@ "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", "type": "string", "nullable": true + }, + "assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true } }, "anyOf": [ @@ -528506,6 +526673,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -528515,6 +526687,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -529491,7 +527675,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 + } } } } @@ -529505,7 +527709,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", @@ -566791,6 +564995,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -567003,6 +565208,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -579973,17 +578179,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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy" }, "parameters": [ { @@ -580022,42 +578228,28 @@ "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", + "example": 1296269 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "type": "string" - }, - "body": { "type": "string", - "nullable": true - }, - "number": { - "type": "integer" + "example": "Hello-World" }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -580181,55 +578373,550 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "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", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "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", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, "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", + "example": "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", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# 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", + "format": "uri", + "nullable": true + } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "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" + ] + } + } + }, + "secret_scanning_validity_checks": { + "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" ] } }, @@ -580237,17 +578924,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=", @@ -580267,1576 +578948,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/enterprise-cloud@latest//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", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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/enterprise-cloud@latest//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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "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", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# 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", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "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" - ] - } - } - }, - "secret_scanning_validity_checks": { - "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_validity_checks": { - "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_validity_checks": { + "status": "disabled" + } } } ] @@ -608846,6 +606048,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.", @@ -657687,6 +654897,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.", @@ -664124,51 +661342,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/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest//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": { @@ -664359,7 +661806,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", @@ -664369,37 +661849,509 @@ "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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/enterprise-cloud@latest//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.", + "example": "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", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was last updated." + } + }, + "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": { @@ -724616,6 +722568,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -726997,6 +724956,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -858270,6 +856236,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.", @@ -860878,6 +858852,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.", @@ -863393,6 +861375,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.", @@ -865908,6 +863898,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.", @@ -868555,6 +866553,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.", @@ -871209,6 +869215,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.", @@ -875486,6 +873500,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.", @@ -1270976,949 +1268998,4357 @@ ] } }, - "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." + }, + "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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" + } + } + } + } + } + } + } + } + } + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + }, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "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", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": 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", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "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", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + }, + "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/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "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", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": 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", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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", @@ -1272047,7 +1273477,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1272062,8 +1273492,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1272071,13 +1273502,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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", - "operationId": "repository/transferred", + "summary": "This event occurs when there is activity relating to 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1272142,200 +1273573,180 @@ "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": { + "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", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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", + "nullable": true + }, + "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", + "nullable": true, + "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", @@ -1273843,7 +1275254,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1273859,23 +1275270,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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1273940,15 +1275349,191 @@ "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", + "nullable": true + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "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/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", @@ -1275455,6 +1277040,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1275470,21 +1277056,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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1275551,13 +1277135,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": { @@ -1277256,11 +1278840,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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1277327,13 +1278911,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": { @@ -1277344,9 +1278928,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1277366,10 +1278947,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": "string", - "nullable": true - }, "dismiss_reason": { "type": "string" }, @@ -1277465,9 +1279042,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1277507,7 +1279081,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1279014,279 +1280589,855 @@ "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/enterprise-cloud@latest//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", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//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": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { + "type": "string", + "description": "The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//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", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true + }, + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1280795,8 +1282946,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1280810,21 +1282960,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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1280889,179 +1283040,630 @@ "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": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", - "type": "object", + "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", + "description": "The reason for resolving the alert.", "nullable": true, - "required": [ - "login", - "id" - ], + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "format": "uri" + "example": "octocat" }, - "deleted": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "email": { + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "gravatar_id": { - "type": "string" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "html_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "login": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//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", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { "name": { + "nullable": true, "type": "string" }, - "node_id": { + "email": { + "nullable": true, "type": "string" }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "example": "User" }, "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, "starred_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "example": "User" }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - }, - "external_identifier": { - "type": "string" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "external_reference": { + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "nullable": true, - "format": "uri" - }, - "fix_reason": { - "type": "string" + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "fixed_at": { + "push_protection_bypass_request_comment": { "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true }, - "node_id": { - "type": "string" + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true }, - "number": { - "type": "integer" + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true }, - "severity": { - "type": "string" + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" - ] + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true } } }, @@ -1282572,8 +1285174,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1282587,21 +1285188,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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -1282666,7 +1285268,7 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { @@ -1283293,74 +1285895,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/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1283382,6 +1285916,314 @@ "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.", + "example": "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", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ] + } + } + }, "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.", @@ -1284798,10 +1287640,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" + } + } } } } @@ -1284813,8 +1287830,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1284823,13 +1287841,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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1284894,13 +1287912,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": { @@ -1285521,6 +1288539,74 @@ } } }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1285542,314 +1288628,6 @@ "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.", - "example": "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", - "example": "/example/secrets.txt" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "example": "/example/Home.md" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082" - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussion-4566270" - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } - ] - } - } - }, "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.", @@ -1287266,185 +1290044,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" - } - } } } } @@ -1287456,9 +1290059,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1287467,11 +1290069,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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1287538,13 +1290140,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": { @@ -1289695,11 +1292297,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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1289766,13 +1292368,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": { @@ -1291923,11 +1294525,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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1291994,13 +1294596,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": { @@ -1292621,6 +1295223,130 @@ } } }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index e891ea64d..e92d04ed7 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.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 @@ -448,7 +446,7 @@ paths: The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. schema: type: string - - &104 + - &108 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For @@ -457,7 +455,7 @@ paths: required: false schema: type: string - - &105 + - &109 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For @@ -466,7 +464,7 @@ paths: required: false schema: type: string - - &106 + - &110 name: direction description: The direction to sort the results by. in: query @@ -687,7 +685,7 @@ paths: required: - vector_string - score - cvss_severities: &125 + cvss_severities: &129 type: object nullable: true properties: @@ -727,7 +725,7 @@ paths: required: - vector_string - score - epss: &126 + epss: &130 type: object nullable: true readOnly: true @@ -865,7 +863,7 @@ paths: - subscriptions_url - type - url - type: &428 + type: &436 type: string description: The type of credit the user is receiving. enum: @@ -998,7 +996,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &250 + schema: &257 title: Validation Error Simple description: Validation Error Simple type: object @@ -1031,7 +1029,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &750 + - &751 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1149,7 +1147,7 @@ paths: GitHub. type: object nullable: true - properties: &212 + properties: &217 id: description: Unique identifier of the GitHub app example: 37 @@ -1171,7 +1169,7 @@ paths: title: Enterprise description: An enterprise on GitHub. type: object - properties: &134 + properties: &138 description: description: A short description of the enterprise. type: string @@ -1213,7 +1211,7 @@ paths: avatar_url: type: string format: uri - required: &135 + required: &139 - id - node_id - name @@ -1282,7 +1280,7 @@ paths: about itself. example: 5 type: integer - required: &213 + required: &218 - id - node_id - owner @@ -1587,7 +1585,7 @@ paths: schema: type: integer default: 30 - - &338 + - &345 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 @@ -1603,7 +1601,7 @@ paths: application/json: schema: type: array - items: &339 + items: &346 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1683,7 +1681,7 @@ paths: - installation_id - repository_id examples: - default: &340 + default: &347 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1715,7 +1713,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &760 + schema: &761 title: Scim Error description: Scim Error type: object @@ -1742,7 +1740,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &249 + schema: &256 title: Validation Error description: Validation Error type: object @@ -1811,7 +1809,7 @@ paths: description: Response content: application/json: - schema: &341 + schema: &348 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1925,7 +1923,7 @@ paths: - request - response examples: - default: &342 + default: &349 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2126,7 +2124,7 @@ paths: parameters: - *17 - *19 - - &217 + - &222 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) @@ -2217,6 +2215,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 @@ -2718,7 +2723,7 @@ paths: suspended_at: suspended_by: headers: - Link: &43 + Link: &47 example: ; rel="next", ; rel="last" schema: @@ -2759,7 +2764,7 @@ paths: application/json: schema: *22 examples: - default: &84 + default: &88 value: id: 1 account: @@ -2909,11 +2914,11 @@ paths: - selected repositories: type: array - items: &74 + items: &78 title: Repository description: A repository on GitHub. type: object - properties: &406 + properties: &413 id: description: Unique identifier of the repository example: 42 @@ -2933,7 +2938,7 @@ paths: title: License Simple description: License Simple type: object - properties: &228 + properties: &233 key: type: string example: mit @@ -2955,7 +2960,7 @@ paths: html_url: type: string format: uri - required: &229 + required: &234 - key - name - url @@ -3351,7 +3356,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &407 + required: &414 - archive_url - assignees_url - blobs_url @@ -7487,6 +7492,158 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: enterprises + "/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/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: &43 + 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 + example: 14 + examples: + default: &44 + value: + max_cache_retention_days: 80 + '403': *29 + '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/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - *41 + requestBody: + required: true + content: + application/json: + schema: *43 + examples: + selected_actions: *44 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: &45 + 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 + example: 10 + examples: + default: &46 + value: + max_cache_size_gb: 150 + '403': *29 + '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/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - *41 + requestBody: + required: true + content: + application/json: + schema: *45 + examples: + selected_actions: *46 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache "/enterprises/{enterprise}/actions/cache/usage": get: summary: Get GitHub Actions cache usage for an enterprise @@ -7508,7 +7665,7 @@ paths: description: Response content: application/json: - schema: &251 + schema: &258 type: object properties: total_active_caches_count: @@ -7523,12 +7680,12 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &252 + default: &259 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 headers: - Link: *43 + Link: *47 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -7566,7 +7723,7 @@ paths: type: integer runners: type: array - items: &44 + items: &48 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -7620,7 +7777,7 @@ paths: - display_name - source nullable: true - machine_size_details: &52 + machine_size_details: &56 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -7716,7 +7873,7 @@ paths: - public_ip_enabled - platform examples: - default: &253 + default: &260 value: total_count: 2 runners: @@ -7758,7 +7915,7 @@ paths: public_ips: [] last_active_on: '2023-04-26T15:23:37Z' headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -7854,9 +8011,9 @@ paths: description: Response content: application/json: - schema: *44 + schema: *48 examples: - default: &53 + default: &57 value: id: 5 name: My hosted ubuntu runner @@ -7913,7 +8070,7 @@ paths: type: integer images: type: array - items: &45 + items: &49 title: GitHub-hosted runner custom image details description: Provides details of a custom runner image type: object @@ -7964,7 +8121,7 @@ paths: - latest_version - state examples: - default: &47 + default: &51 value: total_count: 2 image_versions: @@ -7997,7 +8154,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners parameters: - *41 - - &46 + - &50 name: image_definition_id description: Image definition ID of custom image in: path @@ -8009,9 +8166,9 @@ paths: description: Response content: application/json: - schema: *45 + schema: *49 examples: - default: &254 + default: &261 value: id: 1 platform: linux-x64 @@ -8040,7 +8197,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise parameters: - *41 - - *46 + - *50 responses: '204': description: Response @@ -8063,7 +8220,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise parameters: - - *46 + - *50 - *41 responses: '200': @@ -8080,7 +8237,7 @@ paths: type: integer image_versions: type: array - items: &48 + items: &52 title: GitHub-hosted runner custom image version details. description: Provides details of a hosted runner custom image version @@ -8113,7 +8270,7 @@ paths: - created_on - state_details examples: - default: *47 + default: *51 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -8135,8 +8292,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners parameters: - *41 - - *46 - - &49 + - *50 + - &53 name: version description: Version of a custom image in: path @@ -8149,9 +8306,9 @@ paths: description: Response content: application/json: - schema: *48 + schema: *52 examples: - default: &255 + default: &262 value: version: 1.0.0 size_gb: 75 @@ -8176,8 +8333,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise parameters: - *41 - - *46 - - *49 + - *50 + - *53 responses: '204': description: Response @@ -8214,7 +8371,7 @@ paths: type: integer images: type: array - items: &50 + items: &54 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -8250,7 +8407,7 @@ paths: - display_name - source examples: - default: &51 + default: &55 value: id: ubuntu-20.04 platform: linux-x64 @@ -8290,9 +8447,9 @@ paths: type: integer images: type: array - items: *50 + items: *54 examples: - default: *51 + default: *55 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -8315,7 +8472,7 @@ paths: description: Response content: application/json: - schema: &256 + schema: &263 type: object properties: public_ips: @@ -8340,7 +8497,7 @@ paths: required: - public_ips examples: - default: &257 + default: &264 value: public_ips: current_usage: 17 @@ -8378,9 +8535,9 @@ paths: type: integer machine_specs: type: array - items: *52 + items: *56 examples: - default: &258 + default: &265 value: id: 4-core cpu_cores: 4 @@ -8448,7 +8605,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-enterprise parameters: - *41 - - &54 + - &58 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -8460,11 +8617,11 @@ paths: description: Response content: application/json: - schema: *44 + schema: *48 examples: - default: *53 + default: *57 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -8483,7 +8640,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-enterprise parameters: - *41 - - *54 + - *58 requestBody: required: true content: @@ -8526,9 +8683,9 @@ paths: description: Response content: application/json: - schema: *44 + schema: *48 examples: - default: *53 + default: *57 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -8545,15 +8702,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-enterprise parameters: - *41 - - *54 + - *58 responses: '202': description: Response content: application/json: - schema: *44 + schema: *48 examples: - default: *53 + default: *57 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -8621,7 +8778,7 @@ paths: schema: type: object properties: - enabled_organizations: &55 + enabled_organizations: &59 type: string description: The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. @@ -8634,7 +8791,7 @@ paths: description: The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`. - allowed_actions: &56 + allowed_actions: &60 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -8642,12 +8799,12 @@ paths: - all - local_only - selected - selected_actions_url: &261 + selected_actions_url: &268 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: &57 + sha_pinning_required: &61 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -8689,9 +8846,9 @@ paths: schema: type: object properties: - enabled_organizations: *55 - allowed_actions: *56 - sha_pinning_required: *57 + enabled_organizations: *59 + allowed_actions: *60 + sha_pinning_required: *61 required: - enabled_organizations examples: @@ -8722,7 +8879,7 @@ paths: description: Successfully retrieved the artifact and log retention settings content: application/json: - schema: &263 + schema: &270 type: object properties: days: @@ -8740,7 +8897,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &761 + '401': &762 description: Authorization failure '404': *6 x-github: @@ -8768,7 +8925,7 @@ paths: required: true content: application/json: - schema: &264 + schema: &271 type: object properties: days: @@ -8803,7 +8960,7 @@ paths: description: Response content: application/json: - schema: &58 + schema: &62 type: object properties: approval_policy: @@ -8817,7 +8974,7 @@ paths: required: - approval_policy examples: - default: &265 + default: &272 value: approval_policy: first_time_contributors '404': *6 @@ -8846,7 +9003,7 @@ paths: required: true content: application/json: - schema: *58 + schema: *62 examples: default: summary: Set approval policy to first time contributors @@ -8875,7 +9032,7 @@ paths: description: Response content: application/json: - schema: &266 + schema: &273 type: object required: - run_workflows_from_fork_pull_requests @@ -8901,7 +9058,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &59 + default: &63 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -8929,7 +9086,7 @@ paths: required: true content: application/json: - schema: &267 + schema: &274 type: object required: - run_workflows_from_fork_pull_requests @@ -8952,7 +9109,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *59 + default: *63 responses: '204': description: Empty response for successful settings update @@ -8992,11 +9149,11 @@ paths: type: number organizations: type: array - items: &69 + items: &73 title: Organization Simple description: A GitHub organization. type: object - properties: &116 + properties: &120 login: type: string example: github @@ -9037,7 +9194,7 @@ paths: type: string example: A great organization nullable: true - required: &117 + required: &121 - login - url - id @@ -9054,7 +9211,7 @@ paths: - total_count - organizations examples: - default: &70 + default: &74 value: total_count: 1 organizations: @@ -9133,7 +9290,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *41 - - &60 + - &64 name: org_id description: The unique identifier of the organization. in: path @@ -9162,7 +9319,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *41 - - *60 + - *64 responses: '204': description: Response @@ -9191,7 +9348,7 @@ paths: description: Response content: application/json: - schema: &61 + schema: &65 type: object properties: github_owned_allowed: @@ -9212,7 +9369,7 @@ paths: items: type: string examples: - default: &62 + default: &66 value: github_owned_allowed: true verified_allowed: false @@ -9245,9 +9402,9 @@ paths: required: true content: application/json: - schema: *61 + schema: *65 examples: - selected_actions: *62 + selected_actions: *66 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -9352,17 +9509,17 @@ paths: description: Success response content: application/json: - schema: &270 + schema: &277 type: object properties: - default_workflow_permissions: &63 + default_workflow_permissions: &67 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &64 + can_approve_pull_request_reviews: &68 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -9370,7 +9527,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &65 + default: &69 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -9400,13 +9557,13 @@ paths: required: true content: application/json: - schema: &271 + schema: &278 type: object properties: - default_workflow_permissions: *63 - can_approve_pull_request_reviews: *64 + default_workflow_permissions: *67 + can_approve_pull_request_reviews: *68 examples: - default: *65 + default: *69 responses: '204': description: Success response @@ -9451,7 +9608,7 @@ paths: type: number runner_groups: type: array - items: &66 + items: &70 type: object properties: id: @@ -9630,9 +9787,9 @@ paths: description: Response content: application/json: - schema: *66 + schema: *70 examples: - default: &67 + default: &71 value: id: 2 name: octo-runner-group @@ -9667,7 +9824,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise parameters: - *41 - - &68 + - &72 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -9679,9 +9836,9 @@ paths: description: Response content: application/json: - schema: *66 + schema: *70 examples: - default: *67 + default: *71 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -9701,7 +9858,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise parameters: - *41 - - *68 + - *72 requestBody: required: false content: @@ -9753,7 +9910,7 @@ paths: description: Response content: application/json: - schema: *66 + schema: *70 examples: default: value: @@ -9789,7 +9946,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise parameters: - *41 - - *68 + - *72 responses: '204': description: Response @@ -9813,7 +9970,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *68 + - *72 - *17 - *19 responses: @@ -9828,12 +9985,12 @@ paths: type: number organizations: type: array - items: *69 + items: *73 required: - total_count - organizations examples: - default: *70 + default: *74 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -9853,7 +10010,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *68 + - *72 requestBody: required: true content: @@ -9899,8 +10056,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *68 - - *60 + - *72 + - *64 responses: '204': description: Response @@ -9923,8 +10080,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *68 - - *60 + - *72 + - *64 responses: '204': description: Response @@ -9948,7 +10105,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise parameters: - *41 - - *68 + - *72 - *17 - *19 responses: @@ -9963,7 +10120,7 @@ paths: type: number runners: type: array - items: &72 + items: &76 title: Self hosted runners description: A self hosted runner type: object @@ -9992,7 +10149,7 @@ paths: type: boolean labels: type: array - items: &76 + items: &80 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -10025,7 +10182,7 @@ paths: - total_count - runners examples: - default: &73 + default: &77 value: total_count: 2 runners: @@ -10065,7 +10222,7 @@ paths: name: no-gpu type: custom headers: - Link: *43 + Link: *47 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -10085,7 +10242,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise parameters: - *41 - - *68 + - *72 requestBody: required: true content: @@ -10130,8 +10287,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise parameters: - *41 - - *68 - - &71 + - *72 + - &75 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -10160,8 +10317,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise parameters: - *41 - - *68 - - *71 + - *72 + - *75 responses: '204': description: Response @@ -10204,11 +10361,11 @@ paths: type: number runners: type: array - items: *72 + items: *76 examples: - default: *73 + default: *77 headers: - Link: *43 + Link: *47 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -10236,7 +10393,7 @@ paths: application/json: schema: type: array - items: &275 + items: &282 title: Runner Application description: Runner Application type: object @@ -10261,7 +10418,7 @@ paths: - download_url - filename examples: - default: &276 + default: &283 value: - os: osx architecture: x64 @@ -10345,7 +10502,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &277 + '201': &284 description: Response content: application/json: @@ -10355,7 +10512,7 @@ paths: - runner - encoded_jit_config properties: - runner: *72 + runner: *76 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -10384,7 +10541,7 @@ paths: encoded_jit_config: abc123 '404': *6 '422': *7 - '409': &114 + '409': &118 description: Conflict content: application/json: @@ -10422,7 +10579,7 @@ paths: description: Response content: application/json: - schema: &75 + schema: &79 title: Authentication Token description: Authentication Token type: object @@ -10444,7 +10601,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *74 + items: *78 single_file: type: string example: config.yaml @@ -10460,7 +10617,7 @@ paths: - token - expires_at examples: - default: &278 + default: &285 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -10498,9 +10655,9 @@ paths: description: Response content: application/json: - schema: *75 + schema: *79 examples: - default: &279 + default: &286 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -10524,15 +10681,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *71 + - *75 responses: '200': description: Response content: application/json: - schema: *72 + schema: *76 examples: - default: &280 + default: &287 value: id: 23 name: MBP @@ -10572,7 +10729,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise parameters: - *41 - - *71 + - *75 responses: '204': description: Response @@ -10597,9 +10754,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *71 + - *75 responses: - '200': &77 + '200': &81 description: Response content: application/json: @@ -10613,7 +10770,7 @@ paths: type: integer labels: type: array - items: *76 + items: *80 examples: default: value: @@ -10651,7 +10808,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *71 + - *75 requestBody: required: true content: @@ -10675,7 +10832,7 @@ paths: - gpu - accelerated responses: - '200': *77 + '200': *81 '404': *6 '422': *7 x-github: @@ -10698,7 +10855,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *71 + - *75 requestBody: required: true content: @@ -10723,7 +10880,7 @@ paths: - gpu - accelerated responses: - '200': *77 + '200': *81 '404': *6 '422': *7 x-github: @@ -10746,9 +10903,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *71 + - *75 responses: - '200': &281 + '200': &288 description: Response content: application/json: @@ -10762,7 +10919,7 @@ paths: type: integer labels: type: array - items: *76 + items: *80 examples: default: value: @@ -10803,8 +10960,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *71 - - &282 + - *75 + - &289 name: name description: The name of a self-hosted runner's custom label. in: path @@ -10812,7 +10969,7 @@ paths: schema: type: string responses: - '200': *77 + '200': *81 '404': *6 '422': *7 x-github: @@ -10837,20 +10994,20 @@ paths: description: Response content: application/json: - schema: &82 + schema: &86 title: Announcement Banner description: Announcement at either the repository, organization, or enterprise level type: object properties: - announcement: &78 + announcement: &82 type: string description: The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." example: Very **important** announcement about _something_. nullable: true - expires_at: &79 + expires_at: &83 type: string format: date-time description: 'The time at which the announcement expires. This @@ -10860,7 +11017,7 @@ paths: it to an empty string.' example: '"2021-01-01T00:00:00.000-07:00"' nullable: true - user_dismissible: &80 + user_dismissible: &84 type: boolean description: Whether an announcement can be dismissed by the user. example: false @@ -10871,7 +11028,7 @@ paths: - expires_at - user_dismissible examples: - default: &81 + default: &85 summary: Announcement banner value: announcement: Very **important** announcement about _something_. @@ -10895,18 +11052,18 @@ paths: required: true content: application/json: - schema: &289 + schema: &296 title: Enterprise Announcement description: Enterprise global announcement type: object properties: - announcement: *78 - expires_at: *79 - user_dismissible: *80 + announcement: *82 + expires_at: *83 + user_dismissible: *84 required: - announcement examples: - default: *81 + default: *85 parameters: - *41 responses: @@ -10914,9 +11071,9 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *81 + default: *85 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -11012,7 +11169,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-repositories-belonging-to-an-enterprise-owned-organization parameters: - *41 - - &83 + - &87 name: org description: The organization name. The name is not case sensitive. in: path @@ -11029,7 +11186,7 @@ paths: application/json: schema: type: array - items: &85 + items: &89 title: Accessible Repository description: A repository that may be made accessible to a GitHub App. @@ -11080,7 +11237,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#list-github-apps-installed-on-an-enterprise-owned-organization parameters: - *41 - - *83 + - *87 - *17 - *19 responses: @@ -11175,7 +11332,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#install-a-github-app-on-an-enterprise-owned-organization parameters: - *41 - - *83 + - *87 responses: '200': description: A GitHub App installation that was installed previously. @@ -11183,14 +11340,14 @@ paths: application/json: schema: *22 examples: - default: *84 + default: *88 '201': description: A GitHub App installation. content: application/json: schema: *22 examples: - default: *84 + default: *88 requestBody: required: true content: @@ -11258,7 +11415,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization parameters: - *41 - - *83 + - *87 - *23 responses: '204': @@ -11286,7 +11443,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation parameters: - *41 - - *83 + - *87 - *23 - *17 - *19 @@ -11298,7 +11455,7 @@ paths: application/json: schema: type: array - items: *85 + items: *89 examples: default: value: @@ -11327,7 +11484,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories parameters: - *41 - - *83 + - *87 - *23 requestBody: required: true @@ -11367,7 +11524,7 @@ paths: application/json: schema: *22 examples: - default: *84 + default: *88 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -11388,7 +11545,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#grant-repository-access-to-an-organization-installation parameters: - *41 - - *83 + - *87 - *23 responses: '200': @@ -11398,7 +11555,7 @@ paths: application/json: schema: type: array - items: *85 + items: *89 examples: default: value: @@ -11449,7 +11606,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#remove-repository-access-from-an-organization-installation parameters: - *41 - - *83 + - *87 - *23 responses: '200': @@ -11459,7 +11616,7 @@ paths: application/json: schema: type: array - items: *85 + items: *89 examples: default: value: @@ -11536,7 +11693,7 @@ paths: required: false schema: type: string - - &292 + - &299 name: include description: |- The event types to include: @@ -11554,7 +11711,7 @@ paths: - web - git - all - - &293 + - &300 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. @@ -11562,7 +11719,7 @@ paths: required: false schema: type: string - - &294 + - &301 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. @@ -11570,7 +11727,7 @@ paths: required: false schema: type: string - - &295 + - &302 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -11592,7 +11749,7 @@ paths: application/json: schema: type: array - items: &296 + items: &303 type: object properties: "@timestamp": @@ -11714,7 +11871,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &297 + default: &304 value: - "@timestamp": 1606929874512 action: team.add_member @@ -11893,7 +12050,7 @@ paths: vendor_specific: type: object oneOf: - - &89 + - &93 title: AzureBlobConfig description: Azure Blob Config for audit log streaming configuration. type: object @@ -11912,7 +12069,7 @@ paths: - key_id - encrypted_sas_url - container - - &90 + - &94 title: AzureHubConfig description: Azure Event Hubs Config for audit log streaming configuration. type: object @@ -11931,7 +12088,7 @@ paths: - name - encrypted_connstring - key_id - - &91 + - &95 title: AmazonS3OIDCConfig description: Amazon S3 OIDC Config for audit log streaming configuration. type: object @@ -11959,7 +12116,7 @@ paths: - bucket - key_id - region - - &92 + - &96 title: AmazonS3AccessKeysConfig description: Amazon S3 Access Keys Config for audit log streaming configuration. @@ -11993,7 +12150,7 @@ paths: - encrypted_secret_key - key_id - region - - &93 + - &97 title: SplunkConfig description: Splunk Config for Audit Log Stream Configuration type: object @@ -12021,7 +12178,7 @@ paths: - key_id - port - ssl_verify - - &94 + - &98 title: HecConfig description: Hec Config for Audit Log Stream Configuration type: object @@ -12053,7 +12210,7 @@ paths: - key_id - port - ssl_verify - - &95 + - &99 title: GoogleCloudConfig description: Google Cloud Config for audit log streaming configuration. type: object @@ -12071,7 +12228,7 @@ paths: - bucket - key_id - encrypted_json_credentials - - &96 + - &100 title: DatadogConfig description: Datadog Config for audit log streaming configuration. type: object @@ -12102,7 +12259,7 @@ paths: - stream_type - vendor_specific examples: - default: &97 + default: &101 value: enabled: false stream_type: Azure Event Hubs @@ -12116,7 +12273,7 @@ paths: description: The audit log stream configuration was created successfully. content: application/json: - schema: &86 + schema: &90 title: Get an audit log streaming configuration description: Get an audit log streaming configuration for an enterprise. type: object @@ -12147,7 +12304,7 @@ paths: - created_at - updated_at examples: - default: &87 + default: &91 value: id: 1 stream_type: Splunk @@ -12176,7 +12333,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#list-one-audit-log-streaming-configuration-via-a-stream-id parameters: - *41 - - &88 + - &92 name: stream_id description: The ID of the audit log stream configuration. in: path @@ -12188,9 +12345,9 @@ paths: description: Lists one audit log stream configuration via stream ID. content: application/json: - schema: *86 + schema: *90 examples: - default: *87 + default: *91 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -12210,7 +12367,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#update-an-existing-audit-log-stream-configuration parameters: - *41 - - *88 + - *92 requestBody: required: true content: @@ -12236,28 +12393,28 @@ paths: vendor_specific: type: object oneOf: - - *89 - - *90 - - *91 - - *92 - *93 - *94 - *95 - *96 + - *97 + - *98 + - *99 + - *100 required: - enabled - stream_type - vendor_specific examples: - default: *97 + default: *101 responses: '200': description: Successful update content: application/json: - schema: *86 + schema: *90 examples: - default: *87 + default: *91 '422': description: Validation error content: @@ -12288,7 +12445,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#delete-an-audit-log-streaming-configuration-for-an-enterprise parameters: - *41 - - *88 + - *92 responses: '204': description: The audit log stream configuration was deleted successfully. @@ -12315,13 +12472,13 @@ paths: subcategory: bypass-requests parameters: - *41 - - &98 + - &102 name: organization_name description: The name of the organization to filter on. in: query schema: type: string - - &99 + - &103 name: reviewer description: Filter bypass requests by the handle of the GitHub user who reviewed the bypass request. @@ -12329,7 +12486,7 @@ paths: required: false schema: type: string - - &100 + - &104 name: requester description: Filter bypass requests by the handle of the GitHub user who requested the bypass. @@ -12337,7 +12494,7 @@ paths: required: false schema: type: string - - &101 + - &105 name: time_period description: |- The time period to filter by. @@ -12353,7 +12510,7 @@ paths: - week - month default: day - - &102 + - &106 name: request_status description: The status of the bypass request to filter on. When specified, only requests with this status will be returned. @@ -12380,7 +12537,7 @@ paths: application/json: schema: type: array - items: &298 + items: &305 title: Push rule bypass request description: A bypass request made by a user asking to be exempted from a push rule in this repository. @@ -12497,7 +12654,7 @@ paths: type: array description: The responses to the bypass request. nullable: true - items: &103 + items: &107 title: Bypass response description: A response made by a delegated bypasser to a bypass request. @@ -12541,7 +12698,7 @@ paths: format: uri example: https://github.com/octo-org/smile/exemptions/1 examples: - default: &299 + default: &306 value: - id: 21 number: 42 @@ -12632,11 +12789,11 @@ paths: subcategory: delegated-bypass parameters: - *41 - - *98 - - *99 - - *100 - - *101 - *102 + - *103 + - *104 + - *105 + - *106 - *17 - *19 responses: @@ -12646,7 +12803,7 @@ paths: application/json: schema: type: array - items: &301 + items: &308 title: Secret scanning bypass request description: A bypass request made by a user asking to be exempted from push protection in this repository. @@ -12760,7 +12917,7 @@ paths: type: array description: The responses to the bypass request. nullable: true - items: *103 + items: *107 url: type: string format: uri @@ -12771,7 +12928,7 @@ paths: format: uri example: https://github.com/octo-org/smile/exemptions/1 examples: - default: &302 + default: &309 value: - id: 21 number: 42 @@ -12856,17 +13013,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *41 - - &307 + - &314 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: &107 + schema: &111 type: string description: The name of the tool used to generate the code scanning analysis. - - &308 + - &315 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 @@ -12874,22 +13031,22 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &108 + schema: &112 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. - - *104 - - *105 + - *108 + - *109 - *19 - *17 - - *106 + - *110 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: &309 + schema: &316 type: string description: State of a code scanning alert. enum: @@ -12914,42 +13071,42 @@ paths: application/json: schema: type: array - items: &310 + items: &317 type: object properties: - number: &123 + number: &127 type: integer description: The security alert number. readOnly: true - created_at: &130 + created_at: &134 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: &131 + updated_at: &135 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: &128 + url: &132 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &129 + html_url: &133 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &535 + instances_url: &537 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &109 + state: &113 type: string description: State of a code scanning alert. nullable: true @@ -12957,7 +13114,7 @@ paths: - open - dismissed - fixed - fixed_at: &133 + fixed_at: &137 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -12971,14 +13128,14 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: &132 + dismissed_at: &136 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissed_reason: &536 + dismissed_reason: &538 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -12987,13 +13144,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &537 + dismissed_comment: &539 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &538 + rule: &540 type: object properties: id: @@ -13046,25 +13203,25 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &539 + tool: &541 type: object properties: - name: *107 + name: *111 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *108 - most_recent_instance: &540 + guid: *112 + most_recent_instance: &542 type: object properties: - ref: &533 + ref: &535 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &550 + analysis_key: &552 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -13075,13 +13232,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &551 + category: &553 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: *109 + state: *113 commit_sha: type: string message: @@ -13120,11 +13277,11 @@ paths: - generated - test - library - repository: &115 + repository: &119 title: Simple Repository description: A GitHub repository. type: object - properties: &245 + properties: &252 id: type: integer format: int64 @@ -13351,7 +13508,7 @@ paths: format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. - required: &246 + required: &253 - archive_url - assignees_url - blobs_url @@ -13423,7 +13580,7 @@ paths: - most_recent_instance - repository examples: - default: &311 + default: &318 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -13652,9 +13809,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: *43 + Link: *47 '404': *6 - '503': &190 + '503': &195 description: Service unavailable content: application/json: @@ -13698,8 +13855,8 @@ paths: schema: type: integer default: 30 - - *104 - - *105 + - *108 + - *109 responses: '200': description: Response @@ -13707,7 +13864,7 @@ paths: application/json: schema: type: array - items: &110 + items: &114 type: object description: A code security configuration properties: @@ -14076,7 +14233,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &312 + code_scanning_options: &319 type: object description: Security Configuration feature options for code scanning nullable: true @@ -14093,7 +14250,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &113 + code_scanning_default_setup_options: &117 type: object description: Feature options for code scanning default setup nullable: true @@ -14210,9 +14367,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *110 + schema: *114 examples: - default: &111 + default: &115 value: id: 1325 target_type: enterprise @@ -14270,7 +14427,7 @@ paths: description: Response content: application/json: - schema: &314 + schema: &321 type: array description: A list of default code security configurations items: @@ -14284,9 +14441,9 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *110 + configuration: *114 examples: - default: &315 + default: &322 value: - default_for_new_repos: public configuration: @@ -14375,7 +14532,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise parameters: - *41 - - &112 + - &116 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -14387,9 +14544,9 @@ paths: description: Response content: application/json: - schema: *110 + schema: *114 examples: - default: *111 + default: *115 '304': *37 '403': *29 '404': *6 @@ -14414,7 +14571,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise parameters: - *41 - - *112 + - *116 requestBody: required: true content: @@ -14493,7 +14650,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *113 + code_scanning_default_setup_options: *117 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -14581,13 +14738,13 @@ paths: description: Response content: application/json: - schema: *110 + schema: *114 examples: - default: *111 + default: *115 '304': *37 '403': *29 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14611,14 +14768,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise parameters: - *41 - - *112 + - *116 responses: - '204': &150 + '204': &154 description: A header with no content is returned. '400': *14 '403': *29 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14643,7 +14800,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories parameters: - *41 - - *112 + - *116 requestBody: required: true content: @@ -14670,7 +14827,7 @@ paths: '202': *39 '403': *29 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14695,7 +14852,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise parameters: - *41 - - *112 + - *116 requestBody: required: true content: @@ -14735,12 +14892,12 @@ paths: - none - private_and_internal - public - configuration: *110 + configuration: *114 examples: default: value: default_for_new_repos: all - configuration: &313 + configuration: &320 value: id: 1325 target_type: organization @@ -14797,7 +14954,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration parameters: - *41 - - *112 + - *116 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -14806,8 +14963,8 @@ paths: schema: type: integer default: 30 - - *104 - - *105 + - *108 + - *109 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -14825,7 +14982,7 @@ paths: application/json: schema: type: array - items: &316 + items: &323 type: object description: Repositories associated with a code security configuration and attachment status @@ -14843,13 +15000,13 @@ paths: - failed - updating - removed_by_enterprise - repository: *115 + repository: *119 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: &317 + repository: &324 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -15257,7 +15414,7 @@ paths: visual_studio_subscription_email: '' total_user_accounts: 1 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -15314,7 +15471,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &141 + items: &145 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -15331,14 +15488,14 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *116 - required: *117 + properties: *120 + required: *121 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &303 + - &310 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -15413,7 +15570,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &373 + properties: &380 id: description: Unique identifier of the team type: integer @@ -15485,7 +15642,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &374 + required: &381 - id - node_id - url @@ -15511,7 +15668,7 @@ paths: - slug - parent - type - - &140 + - &144 title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -15621,7 +15778,7 @@ paths: - created_at additionalProperties: false examples: - default: &142 + default: &146 value: total_seats: 2 seats: @@ -15691,7 +15848,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 '500': *40 '401': *25 '403': *29 @@ -16073,7 +16230,7 @@ paths: application/json: schema: type: array - items: &202 + items: &207 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -16380,7 +16537,7 @@ paths: - date additionalProperties: true examples: - default: &203 + default: &208 value: - date: '2024-06-24' total_active_users: 24 @@ -16482,7 +16639,7 @@ paths: '500': *40 '403': *29 '404': *6 - '422': &204 + '422': &209 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -16512,7 +16669,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day parameters: - *41 - - &118 + - &122 name: day description: The day to request data for, in `YYYY-MM-DD` format. in: query @@ -16526,7 +16683,7 @@ paths: description: Response content: application/json: - schema: &119 + schema: &123 type: object title: Copilot Metrics 1 Day Report description: Links to download the Copilot usage metrics report for @@ -16547,7 +16704,7 @@ paths: - download_links - report_day examples: - default: &120 + default: &124 value: download_links: - https://example.com/copilot-usage-report-1.json @@ -16585,7 +16742,7 @@ paths: description: Response content: application/json: - schema: &121 + schema: &125 type: object title: Copilot Metrics 28 Day Report description: Links to download the latest Copilot usage metrics report @@ -16613,7 +16770,7 @@ paths: - report_start_day - report_end_day examples: - default: &122 + default: &126 value: download_links: - https://example.com/copilot-usage-report-1.json @@ -16647,15 +16804,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day parameters: - *41 - - *118 + - *122 responses: '200': description: Response content: application/json: - schema: *119 + schema: *123 examples: - default: *120 + default: *124 '500': *40 '403': *29 '404': *6 @@ -16688,9 +16845,9 @@ paths: description: Response content: application/json: - schema: *121 + schema: *125 examples: - default: *122 + default: *126 '500': *40 '403': *29 '404': *6 @@ -16718,7 +16875,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *41 - - &323 + - &330 name: state in: query description: |- @@ -16727,7 +16884,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &324 + - &331 name: severity in: query description: |- @@ -16736,7 +16893,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &325 + - &332 name: ecosystem in: query description: |- @@ -16745,14 +16902,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &326 + - &333 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 - - &327 + - &334 name: epss_percentage in: query description: |- @@ -16764,7 +16921,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 - - &590 + - &592 name: has in: query description: |- @@ -16778,7 +16935,7 @@ paths: type: string enum: - patch - - &328 + - &335 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -16788,7 +16945,7 @@ paths: enum: - development - runtime - - &329 + - &336 name: sort in: query description: |- @@ -16803,9 +16960,9 @@ paths: - updated - epss_percentage default: created - - *106 - - *104 - - *105 + - *110 + - *108 + - *109 - *17 responses: '200': @@ -16814,11 +16971,11 @@ paths: application/json: schema: type: array - items: &330 + items: &337 type: object description: A Dependabot alert. properties: - number: *123 + number: *127 state: type: string description: The state of the Dependabot alert. @@ -16833,7 +16990,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: &124 + package: &128 type: object description: Details for the vulnerable package. readOnly: true @@ -16877,7 +17034,7 @@ paths: - unknown - direct - transitive - security_advisory: &591 + security_advisory: &593 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -16907,13 +17064,13 @@ paths: description: Vulnerable version range information for the advisory. readOnly: true - items: &127 + items: &131 type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: - package: *124 + package: *128 severity: type: string description: The severity of the vulnerability. @@ -16979,8 +17136,8 @@ paths: - score - vector_string additionalProperties: false - cvss_severities: *125 - epss: *126 + cvss_severities: *129 + epss: *130 cwes: type: array description: Details for the advisory pertaining to Common @@ -17079,12 +17236,12 @@ paths: - updated_at - withdrawn_at additionalProperties: false - security_vulnerability: *127 - url: *128 - html_url: *129 - created_at: *130 - updated_at: *131 - dismissed_at: *132 + security_vulnerability: *131 + url: *132 + html_url: *133 + created_at: *134 + updated_at: *135 + dismissed_at: *136 dismissed_by: title: Simple User description: A GitHub user. @@ -17108,15 +17265,15 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *133 - auto_dismissed_at: &592 + fixed_at: *137 + auto_dismissed_at: &594 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - repository: *115 + repository: *119 required: - number - state @@ -17135,7 +17292,7 @@ paths: - repository additionalProperties: false examples: - default: &331 + default: &338 value: - number: 2 state: dismissed @@ -17498,7 +17655,7 @@ paths: roles: type: array description: The list of enterprise roles available to the enterprise. - items: &139 + items: &143 title: Enterprise Role description: Enterprise custom roles type: object @@ -17532,8 +17689,8 @@ paths: title: Enterprise description: An enterprise on GitHub. type: object - properties: *134 - required: *135 + properties: *138 + required: *139 nullable: true created_at: description: The date and time the role was created. @@ -17623,7 +17780,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-team parameters: - *41 - - &136 + - &140 name: team_slug description: The slug of the enterprise team name. in: path @@ -17663,8 +17820,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-a-team parameters: - *41 - - *136 - - &137 + - *140 + - &141 name: role_id description: The unique identifier of the role. in: path @@ -17703,8 +17860,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-an-enterprise-role-from-a-team parameters: - *41 - - *136 - - *137 + - *140 + - *141 responses: '204': description: Response @@ -17738,7 +17895,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-user parameters: - *41 - - &138 + - &142 name: username description: The handle for the GitHub user account. in: path @@ -17778,8 +17935,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-an-enterprise-user parameters: - *41 - - *138 - - *137 + - *142 + - *141 responses: '204': description: Response @@ -17812,8 +17969,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-enterprise-user-role-assignment parameters: - *41 - - *138 - - *137 + - *142 + - *141 responses: '204': description: Response @@ -17847,13 +18004,13 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#get-an-enterprise-role parameters: - *41 - - *137 + - *141 responses: '200': description: Response content: application/json: - schema: *139 + schema: *143 examples: default: value: @@ -17904,7 +18061,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#list-teams-that-are-assigned-to-an-enterprise-role parameters: - *41 - - *137 + - *141 - *17 - *19 responses: @@ -17914,9 +18071,9 @@ paths: application/json: schema: type: array - items: *140 + items: *144 examples: - default: &205 + default: &210 value: - id: 1 name: Justice League @@ -17955,7 +18112,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#list-users-that-are-assigned-to-an-enterprise-role parameters: - *41 - - *137 + - *141 - *17 - *19 responses: @@ -17987,7 +18144,7 @@ paths: description: Enterprise Team the user has gotten the role through type: array - items: *140 + items: *144 examples: default: value: @@ -18049,7 +18206,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 '403': *29 '404': *6 x-github: @@ -18146,7 +18303,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-an-enterprise-user parameters: - *41 - - *138 + - *142 responses: '200': description: The user's GitHub Copilot seat details, including usage. @@ -18162,9 +18319,9 @@ paths: teams or multiple organizations are only counted once. seats: type: array - items: *141 + items: *145 examples: - default: *142 + default: *146 '500': *40 '401': *25 '403': *29 @@ -18207,7 +18364,7 @@ paths: type: integer network_configurations: type: array - items: &143 + items: &147 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -18247,7 +18404,7 @@ paths: - name - created_on examples: - default: &433 + default: &441 value: total_count: 2 network_configurations: @@ -18266,7 +18423,7 @@ paths: - 6789ABDCEF12345 created_on: '2023-04-26T15:23:37Z' headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -18325,9 +18482,9 @@ paths: description: Response content: application/json: - schema: *143 + schema: *147 examples: - default: &144 + default: &148 value: id: 123456789ABCDEF name: My network configuration @@ -18354,7 +18511,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-configuration-for-an-enterprise parameters: - *41 - - &145 + - &149 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -18366,11 +18523,11 @@ paths: description: Response content: application/json: - schema: *143 + schema: *147 examples: - default: *144 + default: *148 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -18388,7 +18545,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#update-a-hosted-compute-network-configuration-for-an-enterprise parameters: - *41 - - *145 + - *149 requestBody: required: true content: @@ -18427,9 +18584,9 @@ paths: description: Response content: application/json: - schema: *143 + schema: *147 examples: - default: *144 + default: *148 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -18447,7 +18604,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#delete-a-hosted-compute-network-configuration-from-an-enterprise parameters: - *41 - - *145 + - *149 responses: '204': description: Response @@ -18470,7 +18627,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *41 - - &434 + - &442 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -18482,7 +18639,7 @@ paths: description: Response content: application/json: - schema: &435 + schema: &443 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -18516,7 +18673,7 @@ paths: - subnet_id - region examples: - default: &436 + default: &444 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -18524,7 +18681,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: *43 + Link: *47 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -18555,7 +18712,7 @@ paths: application/json: schema: type: array - items: &146 + items: &150 title: Custom Property for Organization description: Custom property defined for an organization allOf: @@ -18622,7 +18779,7 @@ paths: - property_name - value_type examples: - default: &147 + default: &151 value: properties: - property_name: environment @@ -18683,13 +18840,13 @@ paths: type: array description: The array of organization custom properties to create or update. - items: *146 + items: *150 minItems: 1 maxItems: 100 required: - properties examples: - default: *147 + default: *151 responses: '200': description: Response @@ -18697,9 +18854,9 @@ paths: application/json: schema: type: array - items: *146 + items: *150 examples: - default: *147 + default: *151 '403': *29 '404': *6 '422': *7 @@ -18726,7 +18883,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise parameters: - *41 - - &148 + - &152 name: custom_property_name description: The custom property name in: path @@ -18738,9 +18895,9 @@ paths: description: Response content: application/json: - schema: *146 + schema: *150 examples: - default: &149 + default: &153 value: property_name: environment url: https://api.github.com/enterprises/github/org-properties/schema/environment @@ -18777,7 +18934,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise parameters: - *41 - - *148 + - *152 requestBody: required: true content: @@ -18845,9 +19002,9 @@ paths: description: Response content: application/json: - schema: *146 + schema: *150 examples: - default: *149 + default: *153 '403': *29 '404': *6 '422': *7 @@ -18873,9 +19030,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise parameters: - *41 - - *148 + - *152 responses: - '204': *150 + '204': *154 '403': *29 '404': *6 '422': *7 @@ -18924,7 +19081,7 @@ paths: example: Hello-World properties: type: array - items: &151 + items: &155 title: Custom Property Value description: Custom property name and associated value type: object @@ -18961,7 +19118,7 @@ paths: - property_name: team value: octocat headers: - Link: *43 + Link: *47 '403': *29 '404': *6 x-github: @@ -19007,7 +19164,7 @@ paths: type: array description: List of custom property names and associated values to apply to the organizations. - items: *151 + items: *155 required: - organization_logins - properties @@ -19057,7 +19214,7 @@ paths: application/json: schema: type: array - items: &152 + items: &156 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -19121,7 +19278,7 @@ paths: - property_name - value_type examples: - default: &153 + default: &157 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -19178,7 +19335,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *152 + items: *156 minItems: 1 maxItems: 100 required: @@ -19208,9 +19365,9 @@ paths: application/json: schema: type: array - items: *152 + items: *156 examples: - default: *153 + default: *157 '403': *29 '404': *6 x-github: @@ -19233,16 +19390,16 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#promote-a-custom-property-to-an-enterprise parameters: - *41 - - *83 - - *148 + - *87 + - *152 responses: '200': description: Response content: application/json: - schema: *152 + schema: *156 examples: - default: &154 + default: &158 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -19275,15 +19432,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise parameters: - *41 - - *148 + - *152 responses: '200': description: Response content: application/json: - schema: *152 + schema: *156 examples: - default: *154 + default: *158 '403': *29 '404': *6 x-github: @@ -19305,12 +19462,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise parameters: - *41 - - *148 + - *152 requestBody: required: true content: application/json: - schema: &405 + schema: &412 title: Custom Property Set Payload description: Custom property set payload type: object @@ -19372,9 +19529,9 @@ paths: description: Response content: application/json: - schema: *152 + schema: *156 examples: - default: *154 + default: *158 '403': *29 '404': *6 x-github: @@ -19396,9 +19553,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise parameters: - *41 - - *148 + - *152 responses: - '204': *150 + '204': *154 '403': *29 '404': *6 x-github: @@ -19438,7 +19595,7 @@ paths: - push - repository default: branch - enforcement: &163 + enforcement: &167 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights @@ -19451,7 +19608,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &164 + items: &168 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -19492,7 +19649,7 @@ paths: - pull_request - exempt default: always - conditions: &187 + conditions: &192 title: Enterprise ruleset conditions type: object description: Conditions for an enterprise ruleset. The conditions @@ -19506,7 +19663,7 @@ paths: description: Conditions to target organizations by name and all repositories allOf: - - &155 + - &159 title: Repository ruleset conditions for organization names type: object description: Parameters for an organization name condition @@ -19532,7 +19689,7 @@ paths: type: string required: - organization_name - - &158 + - &162 title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -19561,7 +19718,7 @@ paths: is prevented. required: - repository_name - - &157 + - &161 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name condition @@ -19589,8 +19746,8 @@ paths: description: Conditions to target organizations by name and repositories by property allOf: - - *155 - - &160 + - *159 + - &164 title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -19603,7 +19760,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &156 + items: &160 title: Repository ruleset property targeting definition type: object description: Parameters for a targeting a repository @@ -19634,16 +19791,16 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *156 + items: *160 required: - repository_property - - *157 + - *161 - type: object title: organization_id_and_repository_name description: Conditions to target organizations by id and all repositories allOf: - - &159 + - &163 title: Repository ruleset conditions for organization IDs type: object description: Parameters for an organization ID condition @@ -19660,22 +19817,22 @@ paths: type: integer required: - organization_id - - *158 - - *157 + - *162 + - *161 - type: object title: organization_id_and_repository_property description: Conditions to target organization by id and repositories by property allOf: - - *159 - - *160 - - *157 + - *163 + - *164 + - *161 - type: object title: organization_property_and_repository_name description: Conditions to target organizations by property and all repositories allOf: - - &162 + - &166 title: Repository ruleset conditions for organization properties type: object description: Parameters for a organization property condition @@ -19688,7 +19845,7 @@ paths: description: The organization properties and values to include. All of these properties must match for the condition to pass. - items: &161 + items: &165 title: Repository ruleset property targeting definition type: object description: Parameters for a targeting a organization @@ -19712,28 +19869,28 @@ paths: description: The organization properties and values to exclude. The condition will not pass if any of these properties match. - items: *161 + items: *165 required: - organization_property - - *158 - - *157 + - *162 + - *161 - type: object title: organization_property_and_repository_property description: Conditions to target organizations by property and repositories by property allOf: - - *162 - - *160 - - *157 + - *166 + - *164 + - *161 rules: type: array description: An array of rules within the ruleset. - items: &188 + items: &193 title: Repository Rule type: object description: A repository rule. oneOf: - - &165 + - &169 title: creation description: Only allow users with bypass permission to create matching refs. @@ -19745,7 +19902,7 @@ paths: type: string enum: - creation - - &166 + - &170 title: update description: Only allow users with bypass permission to update matching refs. @@ -19766,7 +19923,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &167 + - &171 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -19778,7 +19935,7 @@ paths: type: string enum: - deletion - - &168 + - &172 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -19790,7 +19947,7 @@ paths: type: string enum: - required_linear_history - - &169 + - &173 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches @@ -19814,7 +19971,7 @@ paths: type: string required: - required_deployment_environments - - &170 + - &174 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -19826,7 +19983,7 @@ paths: type: string enum: - required_signatures - - &171 + - &175 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. @@ -19934,7 +20091,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &172 + - &176 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed @@ -19981,7 +20138,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &173 + - &177 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -19993,7 +20150,7 @@ paths: type: string enum: - non_fast_forward - - &174 + - &178 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -20029,43 +20186,43 @@ paths: required: - operator - pattern - - &175 - 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 - - &176 + - &179 + 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 + - &180 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -20101,7 +20258,7 @@ paths: required: - operator - pattern - - &177 + - &181 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -20137,7 +20294,7 @@ paths: required: - operator - pattern - - &178 + - &182 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -20173,7 +20330,7 @@ paths: required: - operator - pattern - - &179 + - &183 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. @@ -20197,7 +20354,7 @@ paths: type: string required: - restricted_file_paths - - &180 + - &184 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit @@ -20221,7 +20378,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &181 + - &185 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -20244,7 +20401,7 @@ paths: type: string required: - restricted_file_extensions - - &182 + - &186 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. @@ -20268,7 +20425,7 @@ paths: maximum: 100 required: - max_file_size - - &183 + - &187 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -20317,7 +20474,7 @@ paths: - repository_id required: - workflows - - &184 + - &188 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning @@ -20377,6 +20534,29 @@ paths: - tool required: - code_scanning_tools + - &189 + 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. required: - name - enforcement @@ -20403,7 +20583,7 @@ paths: description: Response content: application/json: - schema: &185 + schema: &190 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -20438,11 +20618,11 @@ paths: source: type: string description: The name of the source - enforcement: *163 + enforcement: *167 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *164 + items: *168 current_user_can_bypass: type: string description: |- @@ -20474,8 +20654,8 @@ paths: conditions: nullable: true anyOf: - - *157 - - &411 + - *161 + - &418 title: Organization ruleset conditions type: object description: |- @@ -20489,14 +20669,14 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *157 - - *158 + - *161 + - *162 - type: object title: repository_id_and_ref_name description: Conditions to target repositories by id and refs by name allOf: - - *157 + - *161 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -20518,20 +20698,20 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *157 - - *160 + - *161 + - *164 rules: type: array - items: &716 + items: &717 title: Repository Rule type: object description: A repository rule. oneOf: - - *165 - - *166 - - *167 - - *168 - - &713 + - *169 + - *170 + - *171 + - *172 + - &715 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -20609,10 +20789,6 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - *169 - - *170 - - *171 - - *172 - *173 - *174 - *175 @@ -20625,29 +20801,11 @@ paths: - *182 - *183 - *184 - - &714 - 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. + - *185 + - *186 + - *187 + - *188 + - *189 created_at: type: string format: date-time @@ -20655,7 +20813,7 @@ paths: type: string format: date-time examples: - default: &186 + default: &191 value: id: 21 name: super cool ruleset @@ -20714,9 +20872,9 @@ paths: description: Response content: application/json: - schema: *185 + schema: *190 examples: - default: *186 + default: *191 '404': *6 '500': *40 x-github: @@ -20760,16 +20918,16 @@ paths: - tag - push - repository - enforcement: *163 + enforcement: *167 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *164 - conditions: *187 + items: *168 + conditions: *192 rules: description: An array of rules within the ruleset. type: array - items: *188 + items: *193 examples: default: value: @@ -20793,9 +20951,9 @@ paths: description: Response content: application/json: - schema: *185 + schema: *190 examples: - default: *186 + default: *191 '404': *6 '500': *40 x-github: @@ -20857,7 +21015,7 @@ paths: application/json: schema: type: array - items: &189 + items: &194 title: Ruleset version type: object description: The historical version of a ruleset @@ -20881,7 +21039,7 @@ paths: type: string format: date-time examples: - default: &414 + default: &421 value: - version_id: 3 actor: @@ -20934,9 +21092,9 @@ paths: description: Response content: application/json: - schema: &415 + schema: &422 allOf: - - *189 + - *194 - type: object required: - state @@ -20989,7 +21147,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *41 - - &416 + - &423 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -21000,7 +21158,7 @@ paths: enum: - open - resolved - - &417 + - &424 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -21010,7 +21168,7 @@ paths: required: false schema: type: string - - &418 + - &425 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -21019,7 +21177,26 @@ paths: required: false schema: type: string - - &419 + - &426 + 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 + - &427 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. @@ -21031,11 +21208,11 @@ paths: - created - updated default: created - - *106 + - *110 - *17 - - *104 - - *105 - - &420 + - *108 + - *109 + - &428 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -21044,7 +21221,7 @@ paths: required: false schema: type: string - - &421 + - &429 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -21053,7 +21230,7 @@ paths: schema: type: boolean default: false - - &422 + - &430 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -21062,7 +21239,7 @@ paths: schema: type: boolean default: false - - &423 + - &431 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -21078,11 +21255,11 @@ paths: application/json: schema: type: array - items: &424 + items: &432 type: object properties: - number: *123 - created_at: *130 + number: *127 + created_at: *134 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -21090,21 +21267,21 @@ paths: format: date-time readOnly: true nullable: true - url: *128 - html_url: *129 + url: *132 + html_url: *133 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &728 + state: &729 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: &729 + resolution: &730 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -21138,7 +21315,7 @@ paths: secret: type: string description: The secret that was detected. - repository: *115 + repository: *119 push_protection_bypassed: type: boolean description: Whether push protection was bypassed for the detected @@ -21211,8 +21388,8 @@ paths: pull request. ' - oneOf: &730 - - &732 + oneOf: &731 + - &733 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -21264,7 +21441,7 @@ paths: - blob_url - commit_sha - commit_url - - &733 + - &734 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. @@ -21319,7 +21496,7 @@ paths: - page_url - commit_sha - commit_url - - &734 + - &735 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -21333,7 +21510,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &735 + - &736 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -21347,7 +21524,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &736 + - &737 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -21361,7 +21538,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &737 + - &738 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -21375,7 +21552,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &738 + - &739 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -21389,7 +21566,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &739 + - &740 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -21403,7 +21580,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &740 + - &741 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. @@ -21417,7 +21594,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &741 + - &742 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. @@ -21431,7 +21608,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &742 + - &743 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. @@ -21445,7 +21622,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &743 + - &744 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. @@ -21459,7 +21636,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &744 + - &745 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. @@ -21486,7 +21663,7 @@ paths: required: *21 nullable: true examples: - default: &425 + default: &433 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -21662,9 +21839,9 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21695,13 +21872,13 @@ paths: description: Response content: application/json: - schema: &426 + schema: &434 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. type: object properties: - pattern_config_version: &192 + pattern_config_version: &197 type: string description: The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate @@ -21710,7 +21887,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &191 + items: &196 type: object properties: token_type: @@ -21776,9 +21953,9 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *191 + items: *196 examples: - default: &427 + default: &435 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -21833,7 +22010,7 @@ paths: schema: type: object properties: - pattern_config_version: *192 + pattern_config_version: *197 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -21859,7 +22036,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *192 + custom_pattern_version: *197 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -21895,7 +22072,7 @@ paths: '400': *14 '403': *29 '404': *6 - '409': *114 + '409': *118 '422': *15 "/enterprises/{enterprise}/settings/billing/advanced-security": get: @@ -21914,7 +22091,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *41 - - &430 + - &438 name: advanced_security_product in: query description: | @@ -21934,7 +22111,7 @@ paths: description: Success content: application/json: - schema: &431 + schema: &439 type: object properties: total_advanced_security_committers: @@ -21989,7 +22166,7 @@ paths: required: - repositories examples: - default: &432 + default: &440 value: total_advanced_security_committers: 2 total_count: 2 @@ -22032,6 +22209,24 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#get-all-budgets parameters: - *41 + - *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 @@ -22107,6 +22302,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: @@ -22358,7 +22557,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#get-a-budget-by-id parameters: - *41 - - &193 + - &198 name: budget_id description: The ID corresponding to the budget. in: path @@ -22452,7 +22651,7 @@ paths: '404': *6 '403': *29 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -22615,7 +22814,19 @@ paths: update-budget: value: message: Budget successfully updated. - budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b + 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': *25 '403': *29 @@ -22675,7 +22886,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#delete-a-budget parameters: - *41 - - *193 + - *198 responses: '200': description: Response when deleting a budget @@ -22702,7 +22913,7 @@ paths: '404': *6 '403': *29 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -22801,7 +23012,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -22930,7 +23141,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#get-a-cost-center-by-id parameters: - *41 - - &196 + - &201 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -22942,7 +23153,7 @@ paths: description: Response when getting a cost center content: application/json: - schema: &194 + schema: &199 type: object properties: id: @@ -22981,7 +23192,7 @@ paths: - name - resources examples: - default: &195 + default: &200 value: id: 2eeb8ffe-6903-11ee-8c99-0242ac120002 name: Cost Center Name @@ -22995,7 +23206,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -23045,15 +23256,15 @@ paths: description: Response when updating a cost center content: application/json: - schema: *194 + schema: *199 examples: - default: *195 + default: *200 '400': *14 '403': *29 '404': *6 - '409': *114 + '409': *118 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -23071,7 +23282,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#delete-a-cost-center parameters: - *41 - - *196 + - *201 responses: '200': description: Response when deleting a cost center @@ -23110,7 +23321,7 @@ paths: '404': *6 '403': *29 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -23131,7 +23342,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#add-resources-to-a-cost-center parameters: - *41 - - *196 + - *201 requestBody: required: true content: @@ -23201,9 +23412,9 @@ paths: previous_cost_center: yet-another-cost-center '400': *14 '403': *29 - '409': *114 + '409': *118 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -23223,7 +23434,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#remove-resources-from-a-cost-center parameters: - *41 - - *196 + - *201 requestBody: required: true content: @@ -23270,7 +23481,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -23291,7 +23502,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/usage#get-billing-premium-request-usage-report-for-an-enterprise parameters: - *41 - - &197 + - &202 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, @@ -23300,7 +23511,7 @@ paths: required: false schema: type: integer - - &199 + - &204 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 @@ -23309,7 +23520,7 @@ paths: required: false schema: type: integer - - &198 + - &203 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 @@ -23318,7 +23529,7 @@ paths: required: false schema: type: integer - - &200 + - &205 name: organization description: The organization name to query usage for. The name is not case sensitive. @@ -23338,7 +23549,7 @@ paths: required: false schema: type: string - - &201 + - &206 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -23477,7 +23688,7 @@ paths: '403': *29 '404': *6 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -23498,7 +23709,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/usage#get-billing-usage-report-for-an-enterprise parameters: - *41 - - *197 + - *202 - 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 @@ -23507,7 +23718,7 @@ paths: required: false schema: type: integer - - *198 + - *203 - name: cost_center_id description: The ID corresponding to a cost center. The default value is no cost center. @@ -23590,7 +23801,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -23614,17 +23825,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/usage#get-billing-usage-summary-for-an-enterprise parameters: - *41 - - *197 - - *199 - - *198 - - *200 + - *202 + - *204 + - *203 + - *205 - name: repository description: The repository name to query for usage in the format owner/repository. in: query required: false schema: type: string - - *201 + - *206 - name: sku description: The SKU to query for usage. in: query @@ -23757,7 +23968,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -23791,7 +24002,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team parameters: - *41 - - *136 + - *140 - 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`). @@ -23823,13 +24034,13 @@ paths: application/json: schema: type: array - items: *202 + items: *207 examples: - default: *203 + default: *208 '500': *40 '403': *29 '404': *6 - '422': *204 + '422': *209 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -23856,11 +24067,11 @@ paths: application/json: schema: type: array - items: *140 + items: *144 examples: - default: *205 + default: *210 headers: - Link: *43 + Link: *47 '403': *29 x-github: githubCloudOnly: false @@ -23933,9 +24144,9 @@ paths: description: Response content: application/json: - schema: *140 + schema: *144 examples: - default: *205 + default: *210 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23953,7 +24164,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *41 - - &206 + - &211 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -23972,7 +24183,7 @@ paths: type: array items: *4 examples: - default: &207 + default: &212 value: - login: octocat id: 1 @@ -23993,7 +24204,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24011,7 +24222,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *41 - - *206 + - *211 requestBody: required: true content: @@ -24042,7 +24253,7 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24060,7 +24271,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *41 - - *206 + - *211 requestBody: required: true content: @@ -24091,7 +24302,7 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24109,8 +24320,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *41 - - *206 - - *138 + - *211 + - *142 responses: '200': description: User is a member of the enterprise team. @@ -24118,7 +24329,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &208 + exampleKey1: &213 value: login: octocat id: 1 @@ -24154,8 +24365,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *41 - - *206 - - *138 + - *211 + - *142 responses: '201': description: Successfully added team member @@ -24163,7 +24374,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *208 + exampleKey1: *213 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24181,8 +24392,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *41 - - *206 - - *138 + - *211 + - *142 responses: '204': description: Response @@ -24204,7 +24415,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments parameters: - *41 - - *206 + - *211 - *17 - *19 responses: @@ -24214,9 +24425,9 @@ paths: application/json: schema: type: array - items: *69 + items: *73 examples: - default: &209 + default: &214 value: login: github id: 1 @@ -24247,7 +24458,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments parameters: - *41 - - *206 + - *211 requestBody: required: true content: @@ -24275,9 +24486,9 @@ paths: application/json: schema: type: array - items: *69 + items: *73 examples: - default: &244 + default: &249 value: - login: github id: 1 @@ -24308,7 +24519,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments parameters: - *41 - - *206 + - *211 requestBody: required: true content: @@ -24349,16 +24560,16 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment parameters: - *41 - - *206 - - *83 + - *211 + - *87 responses: '200': description: The team is assigned to the organization content: application/json: - schema: *69 + schema: *73 examples: - default: *209 + default: *214 '404': description: The team is not assigned to the organization x-github: @@ -24377,16 +24588,16 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment parameters: - *41 - - *206 - - *83 + - *211 + - *87 responses: '201': description: Successfully assigned the enterprise team to the organization. content: application/json: - schema: *69 + schema: *73 examples: - default: *209 + default: *214 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24403,8 +24614,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment parameters: - *41 - - *206 - - *83 + - *211 + - *87 responses: '204': description: Successfully unassigned the enterprise team from the organization. @@ -24428,7 +24639,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *41 - - &210 + - &215 name: team_slug description: The slug of the team name. in: path @@ -24440,11 +24651,11 @@ paths: description: Response content: application/json: - schema: *140 + schema: *144 examples: - default: *205 + default: *210 headers: - Link: *43 + Link: *47 '403': *29 x-github: githubCloudOnly: false @@ -24462,7 +24673,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *41 - - *210 + - *215 requestBody: required: true content: @@ -24517,11 +24728,11 @@ paths: description: Response content: application/json: - schema: *140 + schema: *144 examples: - default: *205 + default: *210 headers: - Link: *43 + Link: *47 '403': *29 x-github: githubCloudOnly: false @@ -24542,7 +24753,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *41 - - *210 + - *215 responses: '204': description: Response @@ -24641,7 +24852,7 @@ paths: application/json: schema: type: array - items: &239 + items: &244 title: Event description: Event type: object @@ -24651,7 +24862,7 @@ paths: type: type: string nullable: true - actor: &211 + actor: &216 title: Actor description: Actor type: object @@ -24691,18 +24902,18 @@ paths: - id - name - url - org: *211 + org: *216 payload: type: object properties: action: type: string - issue: &227 + issue: &232 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &650 + properties: &652 id: type: integer format: int64 @@ -24814,7 +25025,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &395 + properties: &402 url: type: string format: uri @@ -24884,7 +25095,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &396 + required: &403 - closed_issues - creator - description @@ -24963,7 +25174,7 @@ paths: timeline_url: type: string format: uri - type: &360 + type: &367 title: Issue Type description: The type of issue. type: object @@ -25012,7 +25223,7 @@ paths: - node_id - name - description - repository: *74 + repository: *78 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -25022,9 +25233,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 - author_association: &214 + properties: *217 + required: *218 + author_association: &219 title: author_association type: string example: OWNER @@ -25038,7 +25249,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &215 + reactions: &220 title: Reaction Rollup type: object properties: @@ -25074,7 +25285,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &788 + sub_issues_summary: &789 title: Sub-issues Summary type: object properties: @@ -25094,7 +25305,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &789 + issue_dependencies_summary: &790 title: Issue Dependencies Summary type: object properties: @@ -25113,7 +25324,7 @@ paths: - total_blocking issue_field_values: type: array - items: &790 + items: &791 title: Issue Field Value description: A value assigned to an issue field type: object @@ -25173,7 +25384,7 @@ paths: - node_id - data_type - value - required: &651 + required: &653 - assignee - closed_at - comments @@ -25194,7 +25405,7 @@ paths: - user - created_at - updated_at - comment: &648 + comment: &650 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -25242,7 +25453,7 @@ paths: issue_url: type: string format: uri - author_association: *214 + author_association: *219 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -25252,9 +25463,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 - reactions: *215 + properties: *217 + required: *218 + reactions: *220 required: - id - node_id @@ -25340,7 +25551,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25421,7 +25632,7 @@ paths: _links: type: object properties: - timeline: &216 + timeline: &221 title: Link With Type description: Hypermedia Link with Type type: object @@ -25433,17 +25644,17 @@ paths: required: - href - type - user: *216 - security_advisories: *216 - current_user: *216 - current_user_public: *216 - current_user_actor: *216 - current_user_organization: *216 + user: *221 + security_advisories: *221 + current_user: *221 + current_user_public: *221 + current_user_actor: *221 + current_user_organization: *221 current_user_organizations: type: array - items: *216 - repository_discussions: *216 - repository_discussions_category: *216 + items: *221 + repository_discussions: *221 + repository_discussions_category: *221 required: - timeline - user @@ -25505,7 +25716,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *217 + - *222 - *17 - *19 responses: @@ -25515,7 +25726,7 @@ paths: application/json: schema: type: array - items: &218 + items: &223 title: Base Gist description: Base Gist type: object @@ -25614,7 +25825,7 @@ paths: - created_at - updated_at examples: - default: &219 + default: &224 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -25659,7 +25870,7 @@ paths: site_admin: false truncated: false headers: - Link: *43 + Link: *47 '304': *37 '403': *29 x-github: @@ -25735,7 +25946,7 @@ paths: description: Response content: application/json: - schema: &220 + schema: &225 title: Gist Simple description: Gist Simple type: object @@ -25752,7 +25963,7 @@ paths: url: type: string format: uri - user: &802 + user: &801 title: Public User description: Public User type: object @@ -26114,7 +26325,7 @@ paths: truncated: type: boolean examples: - default: &221 + default: &226 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -26218,7 +26429,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *217 + - *222 - *17 - *19 responses: @@ -26228,11 +26439,11 @@ paths: application/json: schema: type: array - items: *218 + items: *223 examples: - default: *219 + default: *224 headers: - Link: *43 + Link: *47 '422': *15 '304': *37 '403': *29 @@ -26252,7 +26463,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *217 + - *222 - *17 - *19 responses: @@ -26262,11 +26473,11 @@ paths: application/json: schema: type: array - items: *218 + items: *223 examples: - default: *219 + default: *224 headers: - Link: *43 + Link: *47 '401': *25 '304': *37 '403': *29 @@ -26292,7 +26503,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &222 + - &227 name: gist_id description: The unique identifier of the gist. in: path @@ -26304,10 +26515,10 @@ paths: description: Response content: application/json: - schema: *220 + schema: *225 examples: - default: *221 - '403': &225 + default: *226 + '403': &230 description: Forbidden Gist content: application/json: @@ -26355,7 +26566,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *222 + - *227 requestBody: required: true content: @@ -26415,9 +26626,9 @@ paths: description: Response content: application/json: - schema: *220 + schema: *225 examples: - updateGist: *221 + updateGist: *226 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -26575,7 +26786,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *222 + - *227 responses: '204': description: Response @@ -26604,7 +26815,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *222 + - *227 - *17 - *19 responses: @@ -26614,7 +26825,7 @@ paths: application/json: schema: type: array - items: &223 + items: &228 title: Gist Comment description: A comment made to a gist. type: object @@ -26649,7 +26860,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *214 + author_association: *219 required: - url - id @@ -26689,7 +26900,7 @@ paths: updated_at: '2011-04-18T23:23:56Z' author_association: COLLABORATOR headers: - Link: *43 + Link: *47 '304': *37 '404': *6 '403': *29 @@ -26714,7 +26925,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *222 + - *227 requestBody: required: true content: @@ -26739,9 +26950,9 @@ paths: description: Response content: application/json: - schema: *223 + schema: *228 examples: - default: &224 + default: &229 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -26799,8 +27010,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *222 - - &226 + - *227 + - &231 name: comment_id description: The unique identifier of the comment. in: path @@ -26813,12 +27024,12 @@ paths: description: Response content: application/json: - schema: *223 + schema: *228 examples: - default: *224 + default: *229 '304': *37 '404': *6 - '403': *225 + '403': *230 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -26840,8 +27051,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *222 - - *226 + - *227 + - *231 requestBody: required: true content: @@ -26866,9 +27077,9 @@ paths: description: Response content: application/json: - schema: *223 + schema: *228 examples: - default: *224 + default: *229 '404': *6 x-github: githubCloudOnly: false @@ -26885,8 +27096,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *222 - - *226 + - *227 + - *231 responses: '204': description: Response @@ -26909,7 +27120,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *222 + - *227 - *17 - *19 responses: @@ -27010,7 +27221,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *222 + - *227 - *17 - *19 responses: @@ -27020,7 +27231,7 @@ paths: application/json: schema: type: array - items: *220 + items: *225 examples: default: value: @@ -27066,7 +27277,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 '404': *6 '304': *37 '403': *29 @@ -27085,13 +27296,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *222 + - *227 responses: '201': description: Response content: application/json: - schema: *218 + schema: *223 examples: default: value: @@ -27162,7 +27373,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *222 + - *227 responses: '204': description: Response if gist is starred @@ -27192,7 +27403,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *222 + - *227 responses: '204': description: Response @@ -27214,7 +27425,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *222 + - *227 responses: '204': description: Response @@ -27243,7 +27454,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *222 + - *227 - name: sha in: path required: true @@ -27254,9 +27465,9 @@ paths: description: Response content: application/json: - schema: *220 + schema: *225 examples: - default: *221 + default: *226 '422': *15 '404': *6 '403': *29 @@ -27415,7 +27626,7 @@ paths: type: integer repositories: type: array - items: *74 + items: *78 repository_selection: type: string example: selected @@ -27538,7 +27749,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *43 + Link: *47 '403': *29 '304': *37 '401': *25 @@ -27622,7 +27833,7 @@ paths: - closed - all default: open - - &363 + - &370 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -27640,8 +27851,8 @@ paths: - updated - comments default: created - - *106 - - *217 + - *110 + - *222 - name: collab in: query required: false @@ -27671,9 +27882,9 @@ paths: application/json: schema: type: array - items: *227 + items: *232 examples: - default: &364 + default: &371 value: - id: 1 node_id: MDU6SXNzdWUx @@ -27917,7 +28128,7 @@ paths: watchers: 1 author_association: COLLABORATOR headers: - Link: *43 + Link: *47 '422': *15 '304': *37 '404': *6 @@ -27956,8 +28167,8 @@ paths: title: License Simple description: License Simple type: object - properties: *228 - required: *229 + properties: *233 + required: *234 examples: default: value: @@ -28242,7 +28453,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &230 + X-CommonMarker-Version: &235 example: 0.17.4 schema: type: string @@ -28297,7 +28508,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *230 + X-CommonMarker-Version: *235 content: text/html: schema: @@ -28326,7 +28537,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &233 + - &238 name: account_id description: account_id parameter in: path @@ -28338,7 +28549,7 @@ paths: description: Response content: application/json: - schema: &232 + schema: &237 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -28368,7 +28579,7 @@ paths: nullable: true id: type: integer - plan: &231 + plan: &236 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -28457,7 +28668,7 @@ paths: nullable: true updated_at: type: string - plan: *231 + plan: *236 required: - url - id @@ -28465,7 +28676,7 @@ paths: - login - marketplace_purchase examples: - default: &234 + default: &239 value: url: https://api.github.com/orgs/github type: Organization @@ -28550,9 +28761,9 @@ paths: application/json: schema: type: array - items: *231 + items: *236 examples: - default: &235 + default: &240 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -28570,7 +28781,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *43 + Link: *47 '404': *6 '401': *25 x-github: @@ -28592,14 +28803,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &236 + - &241 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &237 + - &242 name: sort description: The property to sort the results by. in: query @@ -28629,9 +28840,9 @@ paths: application/json: schema: type: array - items: *232 + items: *237 examples: - default: &238 + default: &243 value: - url: https://api.github.com/orgs/github type: Organization @@ -28682,7 +28893,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *43 + Link: *47 '404': *6 '422': *15 '401': *25 @@ -28705,15 +28916,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *233 + - *238 responses: '200': description: Response content: application/json: - schema: *232 + schema: *237 examples: - default: *234 + default: *239 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -28745,11 +28956,11 @@ paths: application/json: schema: type: array - items: *231 + items: *236 examples: - default: *235 + default: *240 headers: - Link: *43 + Link: *47 '401': *25 x-github: githubCloudOnly: false @@ -28770,8 +28981,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *236 - - *237 + - *241 + - *242 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -28791,11 +29002,11 @@ paths: application/json: schema: type: array - items: *232 + items: *237 examples: - default: *238 + default: *243 headers: - Link: *43 + Link: *47 '401': *25 x-github: githubCloudOnly: false @@ -29057,14 +29268,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &456 + - &462 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &457 + - &463 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -29081,7 +29292,7 @@ paths: application/json: schema: type: array - items: *239 + items: *244 examples: default: value: @@ -29148,7 +29359,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &680 + - &682 name: all description: If `true`, show notifications marked as read. in: query @@ -29156,7 +29367,7 @@ paths: schema: type: boolean default: false - - &681 + - &683 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -29165,8 +29376,8 @@ paths: schema: type: boolean default: false - - *217 - - &682 + - *222 + - &684 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: @@ -29191,18 +29402,18 @@ paths: application/json: schema: type: array - items: &240 + items: &245 title: Thread description: Thread type: object properties: id: type: string - repository: &274 + repository: &281 title: Minimal Repository description: Minimal Repository type: object - properties: &333 + properties: &340 id: type: integer format: int64 @@ -29478,7 +29689,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &408 + security_and_analysis: &415 nullable: true type: object properties: @@ -29560,7 +29771,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &334 + required: &341 - archive_url - assignees_url - blobs_url @@ -29648,7 +29859,7 @@ paths: - url - subscription_url examples: - default: &683 + default: &685 value: - id: '1' repository: @@ -29730,7 +29941,7 @@ paths: url: https://api.github.com/notifications/threads/1 subscription_url: https://api.github.com/notifications/threads/1/subscription headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -29814,7 +30025,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &241 + - &246 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 @@ -29828,7 +30039,7 @@ paths: description: Response content: application/json: - schema: *240 + schema: *245 examples: default: value: @@ -29931,7 +30142,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *241 + - *246 responses: '205': description: Reset Content @@ -29954,7 +30165,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *241 + - *246 responses: '204': description: No content @@ -29977,13 +30188,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *241 + - *246 responses: '200': description: Response content: application/json: - schema: &242 + schema: &247 title: Thread Subscription description: Thread Subscription type: object @@ -30020,7 +30231,7 @@ paths: - url - subscribed examples: - default: &243 + default: &248 value: subscribed: true ignored: false @@ -30051,7 +30262,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *241 + - *246 requestBody: required: false content: @@ -30072,9 +30283,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *247 examples: - default: *243 + default: *248 '304': *37 '403': *29 '401': *25 @@ -30097,7 +30308,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *241 + - *246 responses: '204': description: Response @@ -30192,9 +30403,9 @@ paths: application/json: schema: type: array - items: *69 + items: *73 examples: - default: *244 + default: *249 headers: Link: example: ; rel="next" @@ -30245,7 +30456,7 @@ paths: type: integer custom_roles: type: array - items: &319 + items: &326 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -30293,7 +30504,7 @@ paths: - created_at - updated_at examples: - default: &320 + default: &327 value: id: 8030 name: Security Engineer @@ -30325,6 +30536,152 @@ paths: category: orgs subcategory: custom-roles deprecated: true + "/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/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization + parameters: + - *87 + responses: + '200': + description: Response + content: + application/json: + schema: &250 + 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 + example: 14 + examples: + default: *44 + '403': *29 + '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/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization + parameters: + - *87 + requestBody: + required: true + content: + application/json: + schema: *250 + examples: + selected_actions: *44 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization + parameters: + - *87 + responses: + '200': + description: Response + content: + application/json: + schema: &251 + 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 + example: 10 + examples: + default: *46 + '403': *29 + '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/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization + parameters: + - *87 + requestBody: + required: true + content: + application/json: + schema: *251 + examples: + selected_actions: *46 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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 @@ -30340,7 +30697,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization parameters: - - *83 + - *87 - name: page in: query description: The page number of results to fetch. @@ -30384,8 +30741,8 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: *245 - required: *246 + properties: *252 + required: *253 nullable: true additionalProperties: false examples: @@ -30491,7 +30848,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -30557,7 +30914,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *83 + - *87 requestBody: required: true content: @@ -30609,7 +30966,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -30617,9 +30974,9 @@ paths: application/json: schema: type: array - items: *151 + items: *155 examples: - default: &689 + default: &691 value: - property_name: environment value: production @@ -30653,7 +31010,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -30665,11 +31022,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the organization. - items: *151 + items: *155 required: - properties examples: - default: &690 + default: &692 value: properties: - property_name: environment @@ -30710,13 +31067,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: &247 + schema: &254 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -31049,7 +31406,7 @@ paths: - updated_at - archived_at examples: - default-response: &248 + default-response: &255 value: login: github id: 1 @@ -31151,7 +31508,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - - *83 + - *87 requestBody: required: false content: @@ -31374,18 +31731,18 @@ paths: description: Response content: application/json: - schema: *247 + schema: *254 examples: - default: *248 + default: *255 '422': description: Validation failed content: application/json: schema: oneOf: - - *249 - - *250 - '409': *114 + - *256 + - *257 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31408,7 +31765,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - - *83 + - *87 responses: '202': *39 '404': *6 @@ -31433,17 +31790,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *251 + schema: *258 examples: - default: *252 + default: *259 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31464,7 +31821,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - - *83 + - *87 - *17 - *19 responses: @@ -31482,7 +31839,7 @@ paths: type: integer repository_cache_usages: type: array - items: &473 + items: &475 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -31517,7 +31874,7 @@ paths: active_caches_size_in_bytes: 1022142 active_caches_count: 2 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31537,7 +31894,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *83 + - *87 - *17 - *19 responses: @@ -31555,11 +31912,11 @@ paths: type: integer runners: type: array - items: *44 + items: *48 examples: - default: *253 + default: *260 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31577,7 +31934,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -31654,9 +32011,9 @@ paths: description: Response content: application/json: - schema: *44 + schema: *48 examples: - default: *53 + default: *57 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -31676,7 +32033,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -31692,9 +32049,9 @@ paths: type: integer images: type: array - items: *45 + items: *49 examples: - default: *47 + default: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31714,16 +32071,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners parameters: - - *83 - - *46 + - *87 + - *50 responses: '200': description: Response content: application/json: - schema: *45 + schema: *49 examples: - default: *254 + default: *261 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31742,8 +32099,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-organization parameters: - - *83 - - *46 + - *87 + - *50 responses: '204': description: Response @@ -31766,8 +32123,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization parameters: - - *46 - - *83 + - *50 + - *87 responses: '200': description: Response @@ -31783,9 +32140,9 @@ paths: type: integer image_versions: type: array - items: *48 + items: *52 examples: - default: *47 + default: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31805,17 +32162,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners parameters: - - *83 - - *46 - - *49 + - *87 + - *50 + - *53 responses: '200': description: Response content: application/json: - schema: *48 + schema: *52 examples: - default: *255 + default: *262 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31834,9 +32191,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization parameters: - - *83 - - *46 - - *49 + - *87 + - *50 + - *53 responses: '204': description: Response @@ -31857,7 +32214,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -31873,9 +32230,9 @@ paths: type: integer images: type: array - items: *50 + items: *54 examples: - default: *51 + default: *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31893,7 +32250,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -31909,9 +32266,9 @@ paths: type: integer images: type: array - items: *50 + items: *54 examples: - default: *51 + default: *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31928,15 +32285,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *256 + schema: *263 examples: - default: *257 + default: *264 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31954,7 +32311,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -31970,9 +32327,9 @@ paths: type: integer machine_specs: type: array - items: *52 + items: *56 examples: - default: *258 + default: *265 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31990,7 +32347,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -32034,18 +32391,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - - *83 - - *54 + - *87 + - *58 responses: '200': description: Response content: application/json: - schema: *44 + schema: *48 examples: - default: *53 + default: *57 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32063,8 +32420,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *83 - - *54 + - *87 + - *58 requestBody: required: true content: @@ -32107,9 +32464,9 @@ paths: description: Response content: application/json: - schema: *44 + schema: *48 examples: - default: *53 + default: *57 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -32125,16 +32482,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *83 - - *54 + - *87 + - *58 responses: '202': description: Response content: application/json: - schema: *44 + schema: *48 examples: - default: *53 + default: *57 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -32154,13 +32511,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *83 + - *87 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &259 + schema: &266 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -32174,7 +32531,7 @@ paths: required: - include_claim_keys examples: - default: &260 + default: &267 value: include_claim_keys: - repo @@ -32196,20 +32553,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: application/json: - schema: *259 + schema: *266 examples: - default: *260 + default: *267 responses: '201': description: Empty response content: application/json: - schema: &285 + schema: &292 title: Empty Object description: An object without any properties. type: object @@ -32239,7 +32596,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -32248,7 +32605,7 @@ paths: schema: type: object properties: - enabled_repositories: &262 + enabled_repositories: &269 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -32261,9 +32618,9 @@ paths: description: The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. - allowed_actions: *56 - selected_actions_url: *261 - sha_pinning_required: *57 + allowed_actions: *60 + selected_actions_url: *268 + sha_pinning_required: *61 required: - enabled_repositories examples: @@ -32293,7 +32650,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *83 + - *87 responses: '204': description: Response @@ -32304,9 +32661,9 @@ paths: schema: type: object properties: - enabled_repositories: *262 - allowed_actions: *56 - sha_pinning_required: *57 + enabled_repositories: *269 + allowed_actions: *60 + sha_pinning_required: *61 required: - enabled_repositories examples: @@ -32334,13 +32691,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *263 + schema: *270 examples: response: summary: Example response @@ -32366,12 +32723,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: application/json: - schema: *264 + schema: *271 examples: application/json: value: @@ -32381,7 +32738,7 @@ paths: description: No content '403': *29 '404': *6 - '409': *114 + '409': *118 '422': *15 x-github: enabledForGitHubApps: true @@ -32401,15 +32758,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *58 + schema: *62 examples: - default: *265 + default: *272 '404': *6 x-github: enabledForGitHubApps: true @@ -32428,7 +32785,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *83 + - *87 responses: '204': description: Response @@ -32438,7 +32795,7 @@ paths: required: true content: application/json: - schema: *58 + schema: *62 examples: default: summary: Set approval policy to first time contributors @@ -32460,15 +32817,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *266 + schema: *273 examples: - default: *59 + default: *63 '403': *29 '404': *6 x-github: @@ -32486,14 +32843,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: application/json: - schema: *267 + schema: *274 examples: - default: *59 + default: *63 responses: '204': description: Empty response for successful settings update @@ -32523,7 +32880,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *83 + - *87 - *17 - *19 responses: @@ -32541,9 +32898,9 @@ paths: type: number repositories: type: array - items: *74 + items: *78 examples: - default: &269 + default: &276 value: total_count: 1 repositories: @@ -32683,7 +33040,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *83 + - *87 responses: '204': description: Response @@ -32727,8 +33084,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *83 - - &268 + - *87 + - &275 name: repository_id description: The unique identifier of the repository. in: path @@ -32756,8 +33113,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *83 - - *268 + - *87 + - *275 responses: '204': description: Response @@ -32780,15 +33137,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *61 + schema: *65 examples: - default: *62 + default: *66 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -32811,7 +33168,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *83 + - *87 responses: '204': description: Response @@ -32819,9 +33176,9 @@ paths: required: false content: application/json: - schema: *61 + schema: *65 examples: - selected_actions: *62 + selected_actions: *66 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -32841,7 +33198,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -32889,7 +33246,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -32916,7 +33273,7 @@ paths: description: No content '403': *29 '404': *6 - '409': *114 + '409': *118 '422': *15 x-github: enabledForGitHubApps: true @@ -32936,7 +33293,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *83 + - *87 - *17 - *19 responses: @@ -32951,9 +33308,9 @@ paths: type: integer repositories: type: array - items: *74 + items: *78 examples: - default: *269 + default: *276 '403': *29 '404': *6 x-github: @@ -32973,7 +33330,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -33021,14 +33378,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *83 - - *268 + - *87 + - *275 responses: '204': description: No content '403': *29 '404': *6 - '409': *114 + '409': *118 '422': *15 x-github: enabledForGitHubApps: true @@ -33048,14 +33405,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *83 - - *268 + - *87 + - *275 responses: '204': description: No content '403': *29 '404': *6 - '409': *114 + '409': *118 '422': *15 x-github: enabledForGitHubApps: true @@ -33077,15 +33434,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *270 + schema: *277 examples: - default: *65 + default: *69 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33106,7 +33463,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *83 + - *87 responses: '204': description: Success response @@ -33117,9 +33474,9 @@ paths: required: false content: application/json: - schema: *271 + schema: *278 examples: - default: *65 + default: *69 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33139,7 +33496,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *83 + - *87 - *17 - *19 - name: visible_to_repository @@ -33164,7 +33521,7 @@ paths: type: number runner_groups: type: array - items: &272 + items: &279 type: object properties: id: @@ -33280,7 +33637,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -33352,9 +33709,9 @@ paths: description: Response content: application/json: - schema: *272 + schema: *279 examples: - default: &273 + default: &280 value: id: 2 name: octo-runner-group @@ -33389,14 +33746,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *83 - - *68 + - *87 + - *72 responses: '200': description: Response content: application/json: - schema: *272 + schema: *279 examples: default: value: @@ -33432,8 +33789,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *83 - - *68 + - *87 + - *72 requestBody: required: true content: @@ -33487,9 +33844,9 @@ paths: description: Response content: application/json: - schema: *272 + schema: *279 examples: - default: *273 + default: *280 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -33508,8 +33865,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *83 - - *68 + - *87 + - *72 responses: '204': description: Response @@ -33532,8 +33889,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - - *83 - - *68 + - *87 + - *72 - *17 - *19 responses: @@ -33551,11 +33908,11 @@ paths: type: number runners: type: array - items: *44 + items: *48 examples: - default: *253 + default: *260 headers: - Link: *43 + Link: *47 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -33575,8 +33932,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *83 - - *68 + - *87 + - *72 - *19 - *17 responses: @@ -33594,9 +33951,9 @@ paths: type: number repositories: type: array - items: *274 + items: *281 examples: - default: &805 + default: &804 value: total_count: 1 repositories: @@ -33848,8 +34205,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *83 - - *68 + - *87 + - *72 requestBody: required: true content: @@ -33893,9 +34250,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *83 - - *68 - - *268 + - *87 + - *72 + - *275 responses: '204': description: Response @@ -33917,9 +34274,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *83 - - *68 - - *268 + - *87 + - *72 + - *275 responses: '204': description: Response @@ -33942,8 +34299,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *83 - - *68 + - *87 + - *72 - *17 - *19 responses: @@ -33961,11 +34318,11 @@ paths: type: number runners: type: array - items: *72 + items: *76 examples: - default: *73 + default: *77 headers: - Link: *43 + Link: *47 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -33984,8 +34341,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *83 - - *68 + - *87 + - *72 requestBody: required: true content: @@ -34029,9 +34386,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *83 - - *68 - - *71 + - *87 + - *72 + - *75 responses: '204': description: Response @@ -34053,9 +34410,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *83 - - *68 - - *71 + - *87 + - *72 + - *75 responses: '204': description: Response @@ -34085,7 +34442,7 @@ paths: in: query schema: type: string - - *83 + - *87 - *17 - *19 responses: @@ -34103,11 +34460,11 @@ paths: type: integer runners: type: array - items: *72 + items: *76 examples: - default: *73 + default: *77 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34129,7 +34486,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -34137,9 +34494,9 @@ paths: application/json: schema: type: array - items: *275 + items: *282 examples: - default: *276 + default: *283 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34161,7 +34518,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -34204,10 +34561,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *277 + '201': *284 '404': *6 '422': *7 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34235,15 +34592,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *83 + - *87 responses: '201': description: Response content: application/json: - schema: *75 + schema: *79 examples: - default: *278 + default: *285 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34271,15 +34628,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *83 + - *87 responses: '201': description: Response content: application/json: - schema: *75 + schema: *79 examples: - default: *279 + default: *286 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34301,16 +34658,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *83 - - *71 + - *87 + - *75 responses: '200': description: Response content: application/json: - schema: *72 + schema: *76 examples: - default: *280 + default: *287 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34331,8 +34688,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *83 - - *71 + - *87 + - *75 responses: '204': description: Response @@ -34358,10 +34715,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *83 - - *71 + - *87 + - *75 responses: - '200': *77 + '200': *81 '404': *6 x-github: githubCloudOnly: false @@ -34383,8 +34740,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *83 - - *71 + - *87 + - *75 requestBody: required: true content: @@ -34408,7 +34765,7 @@ paths: - gpu - accelerated responses: - '200': *77 + '200': *81 '404': *6 '422': *7 x-github: @@ -34432,8 +34789,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *83 - - *71 + - *87 + - *75 requestBody: required: true content: @@ -34458,7 +34815,7 @@ paths: - gpu - accelerated responses: - '200': *77 + '200': *81 '404': *6 '422': *7 x-github: @@ -34482,10 +34839,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *83 - - *71 + - *87 + - *75 responses: - '200': *281 + '200': *288 '404': *6 x-github: githubCloudOnly: false @@ -34512,11 +34869,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *83 - - *71 - - *282 + - *87 + - *75 + - *289 responses: - '200': *77 + '200': *81 '404': *6 '422': *7 x-github: @@ -34541,7 +34898,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - - *83 + - *87 - *17 - *19 responses: @@ -34559,7 +34916,7 @@ paths: type: integer secrets: type: array - items: &283 + items: &290 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -34609,7 +34966,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34632,13 +34989,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: &493 + schema: &495 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -34667,7 +35024,7 @@ paths: - key_id - key examples: - default: &494 + default: &496 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -34692,8 +35049,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - - *83 - - &284 + - *87 + - &291 name: secret_name description: The name of the secret. in: path @@ -34705,7 +35062,7 @@ paths: description: Response content: application/json: - schema: *283 + schema: *290 examples: default: value: @@ -34735,8 +35092,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 requestBody: required: true content: @@ -34793,7 +35150,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -34819,8 +35176,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 responses: '204': description: Response @@ -34846,8 +35203,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 - *19 - *17 responses: @@ -34865,9 +35222,9 @@ paths: type: integer repositories: type: array - items: *274 + items: *281 examples: - default: &288 + default: &295 value: total_count: 1 repositories: @@ -34959,8 +35316,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 requestBody: required: true content: @@ -35012,8 +35369,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 - name: repository_id in: path required: true @@ -35046,8 +35403,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 - name: repository_id in: path required: true @@ -35079,8 +35436,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - - *83 - - &478 + - *87 + - &480 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -35104,7 +35461,7 @@ paths: type: integer variables: type: array - items: &286 + items: &293 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -35168,7 +35525,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35189,7 +35546,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - - *83 + - *87 requestBody: required: true content: @@ -35237,7 +35594,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -35262,8 +35619,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - - *83 - - &287 + - *87 + - &294 name: name description: The name of the variable. in: path @@ -35275,7 +35632,7 @@ paths: description: Response content: application/json: - schema: *286 + schema: *293 examples: default: value: @@ -35305,8 +35662,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - - *83 - - *287 + - *87 + - *294 requestBody: required: true content: @@ -35368,8 +35725,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - - *83 - - *287 + - *87 + - *294 responses: '204': description: Response @@ -35395,8 +35752,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *83 - - *287 + - *87 + - *294 - *19 - *17 responses: @@ -35414,9 +35771,9 @@ paths: type: integer repositories: type: array - items: *274 + items: *281 examples: - default: *288 + default: *295 '409': description: Response when the visibility of the variable is not set to `selected` @@ -35442,8 +35799,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *83 - - *287 + - *87 + - *294 requestBody: required: true content: @@ -35492,8 +35849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *83 - - *287 + - *87 + - *294 - name: repository_id in: path required: true @@ -35527,8 +35884,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *83 - - *287 + - *87 + - *294 - name: repository_id in: path required: true @@ -35559,15 +35916,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *81 + default: *85 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -35586,19 +35943,19 @@ paths: required: true content: application/json: - schema: *289 + schema: *296 examples: - default: *81 + default: *85 parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *81 + default: *85 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -35614,7 +35971,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - - *83 + - *87 responses: '204': description: Response @@ -35636,7 +35993,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#create-an-artifact-deployment-record parameters: - - *83 + - *87 requestBody: required: true content: @@ -35743,7 +36100,7 @@ paths: type: integer deployment_records: type: array - items: &290 + items: &297 title: Artifact Deployment Record description: Artifact Metadata Deployment Record type: object @@ -35787,7 +36144,7 @@ paths: with the deployment record. nullable: true examples: - default: &291 + default: &298 value: total_count: 1 deployment_records: @@ -35818,7 +36175,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#set-cluster-deployment-records parameters: - - *83 + - *87 - name: cluster in: path description: The cluster name. @@ -35933,9 +36290,9 @@ paths: type: integer deployment_records: type: array - items: *290 + items: *297 examples: - default: *291 + default: *298 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35955,7 +36312,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - - *83 + - *87 requestBody: required: true content: @@ -36106,7 +36463,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#list-artifact-deployment-records parameters: - - *83 + - *87 - name: subject_digest description: The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. in: path @@ -36131,9 +36488,9 @@ paths: type: integer deployment_records: type: array - items: *290 + items: *297 examples: - default: *291 + default: *298 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36153,7 +36510,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - - *83 + - *87 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -36236,9 +36593,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *104 - - *105 - - *83 + - *108 + - *109 + - *87 requestBody: required: true content: @@ -36262,12 +36619,12 @@ paths: required: - subject_digests examples: - default: &833 + default: &832 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &834 + withPredicateType: &833 value: subject_digests: - sha256:abc123 @@ -36325,7 +36682,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &835 + default: &834 value: attestations_subject_digests: - sha256:abc: @@ -36434,7 +36791,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *83 + - *87 requestBody: required: true content: @@ -36499,7 +36856,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *83 + - *87 - name: subject_digest description: Subject Digest in: path @@ -36532,9 +36889,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestation-repositories parameters: - *17 - - *104 - - *105 - - *83 + - *108 + - *109 + - *87 - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. @@ -36582,7 +36939,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id parameters: - - *83 + - *87 - name: attestation_id description: Attestation ID in: path @@ -36618,9 +36975,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations parameters: - *17 - - *104 - - *105 - - *83 + - *108 + - *109 + - *87 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -36674,7 +37031,7 @@ paths: initiator: type: string examples: - default: &507 + default: &509 value: attestations: - bundle: @@ -36792,7 +37149,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization parameters: - - *83 + - *87 - name: phrase description: A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). @@ -36800,10 +37157,10 @@ paths: required: false schema: type: string - - *292 - - *293 - - *294 - - *295 + - *299 + - *300 + - *301 + - *302 - *17 responses: '200': @@ -36812,9 +37169,9 @@ paths: application/json: schema: type: array - items: *296 + items: *303 examples: - default: *297 + default: *304 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -36831,7 +37188,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *83 + - *87 - *17 - *19 responses: @@ -36843,7 +37200,7 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36862,8 +37219,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: If the user is blocked @@ -36888,8 +37245,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response @@ -36909,8 +37266,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response @@ -36936,17 +37293,17 @@ paths: category: orgs subcategory: bypass-requests parameters: - - *83 - - &300 + - *87 + - &307 name: repository_name description: The name of the repository to filter on. in: query schema: type: string - - *99 - - *100 - - *101 - - *102 + - *103 + - *104 + - *105 + - *106 - *17 - *19 responses: @@ -36956,9 +37313,9 @@ paths: application/json: schema: type: array - items: *298 + items: *305 examples: - default: *299 + default: *306 '404': *6 '500': *40 "/orgs/{org}/bypass-requests/secret-scanning": @@ -36981,12 +37338,12 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *83 - - *300 - - *99 - - *100 - - *101 - - *102 + - *87 + - *307 + - *103 + - *104 + - *105 + - *106 - *17 - *19 responses: @@ -36996,9 +37353,9 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *302 + default: *309 '404': *6 '500': *40 "/orgs/{org}/campaigns": @@ -37017,15 +37374,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *83 + - *87 - *19 - *17 - - *106 + - *110 - name: state description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &304 + schema: &311 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -37051,7 +37408,7 @@ paths: application/json: schema: type: array - items: &305 + items: &312 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -37082,7 +37439,7 @@ paths: team_managers: description: The campaign team managers type: array - items: *303 + items: *310 published_at: description: The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. @@ -37100,7 +37457,7 @@ paths: type: string format: date-time nullable: true - state: *304 + state: *311 contact_link: description: The contact link of the campaign. type: string @@ -37195,9 +37552,9 @@ paths: closed_at: state: open headers: - Link: *43 + Link: *47 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37221,7 +37578,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -37320,9 +37677,9 @@ paths: description: Response content: application/json: - schema: *305 + schema: *312 examples: - default: &306 + default: &313 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -37371,7 +37728,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37393,7 +37750,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *83 + - *87 - name: campaign_number description: The campaign number. in: path @@ -37405,16 +37762,16 @@ paths: description: Response content: application/json: - schema: *305 + schema: *312 examples: - default: *306 + default: *313 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37435,7 +37792,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign parameters: - - *83 + - *87 - name: campaign_number description: The campaign number. in: path @@ -37484,7 +37841,7 @@ paths: type: string format: uri nullable: true - state: *304 + state: *311 examples: default: value: @@ -37494,9 +37851,9 @@ paths: description: Response content: application/json: - schema: *305 + schema: *312 examples: - default: *306 + default: *313 '400': description: Bad Request content: @@ -37508,7 +37865,7 @@ paths: content: application/json: schema: *3 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37529,7 +37886,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *83 + - *87 - name: campaign_number description: The campaign number. in: path @@ -37540,7 +37897,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37562,20 +37919,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *83 - - *307 - - *308 - - *104 - - *105 + - *87 + - *314 + - *315 + - *108 + - *109 - *19 - *17 - - *106 + - *110 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: *309 + schema: *316 - name: sort description: The property by which to sort the results. in: query @@ -37591,7 +37948,7 @@ paths: be returned. in: query required: false - schema: &534 + schema: &536 type: string description: Severity of a code scanning alert. enum: @@ -37609,13 +37966,13 @@ paths: application/json: schema: type: array - items: *310 + items: *317 examples: - default: *311 + default: *318 headers: - Link: *43 + Link: *47 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37637,7 +37994,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *83 + - *87 - name: target_type in: query description: The target type of the code security configuration @@ -37656,8 +38013,8 @@ paths: schema: type: integer default: 30 - - *104 - - *105 + - *108 + - *109 responses: '200': description: Response @@ -37665,7 +38022,7 @@ paths: application/json: schema: type: array - items: *110 + items: *114 examples: default: value: @@ -37748,7 +38105,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - - *83 + - *87 requestBody: required: true content: @@ -37826,7 +38183,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *312 + code_scanning_options: *319 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -37835,7 +38192,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: *113 + code_scanning_default_setup_options: *117 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -37967,9 +38324,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *110 + schema: *114 examples: - default: *313 + default: *320 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37991,15 +38348,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '304': *37 '403': *29 '404': *6 @@ -38025,7 +38382,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *83 + - *87 requestBody: required: true content: @@ -38051,11 +38408,11 @@ paths: - 32 - 91 responses: - '204': *150 + '204': *154 '400': *14 '403': *29 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38077,16 +38434,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - - *83 - - *112 + - *87 + - *116 responses: '200': description: Response content: application/json: - schema: *110 + schema: *114 examples: - default: *313 + default: *320 '304': *37 '403': *29 '404': *6 @@ -38110,8 +38467,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - - *83 - - *112 + - *87 + - *116 requestBody: required: true content: @@ -38190,7 +38547,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *113 + code_scanning_default_setup_options: *117 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -38308,7 +38665,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *110 + schema: *114 examples: default: value: @@ -38367,14 +38724,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *83 - - *112 + - *87 + - *116 responses: - '204': *150 + '204': *154 '400': *14 '403': *29 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38398,8 +38755,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *83 - - *112 + - *87 + - *116 requestBody: required: true content: @@ -38462,8 +38819,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *83 - - *112 + - *87 + - *116 requestBody: required: true content: @@ -38503,12 +38860,12 @@ paths: - none - private_and_internal - public - configuration: *110 + configuration: *114 examples: default: value: default_for_new_repos: all - configuration: *313 + configuration: *320 '403': *29 '404': *6 x-github: @@ -38532,8 +38889,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *83 - - *112 + - *87 + - *116 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -38542,8 +38899,8 @@ paths: schema: type: integer default: 30 - - *104 - - *105 + - *108 + - *109 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -38561,13 +38918,13 @@ paths: application/json: schema: type: array - items: *316 + items: *323 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *317 + repository: *324 '403': *29 '404': *6 x-github: @@ -38591,7 +38948,7 @@ paths: parameters: - *17 - *19 - - *83 + - *87 responses: '200': description: Response @@ -38607,7 +38964,7 @@ paths: type: integer codespaces: type: array - items: &365 + items: &372 type: object title: Codespace description: A codespace. @@ -38632,12 +38989,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *274 + repository: *281 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &563 + properties: &565 name: type: string description: The name of the machine. @@ -38679,7 +39036,7 @@ paths: - ready - in_progress nullable: true - required: &564 + required: &566 - name - display_name - operating_system @@ -38884,7 +39241,7 @@ paths: - pulls_url - recent_folders examples: - default: &366 + default: &373 value: total_count: 3 codespaces: @@ -39316,7 +39673,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *83 + - *87 deprecated: true requestBody: required: true @@ -39383,7 +39740,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *83 + - *87 deprecated: true requestBody: required: true @@ -39438,7 +39795,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *83 + - *87 requestBody: required: true content: @@ -39490,7 +39847,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *83 + - *87 - *17 - *19 responses: @@ -39508,7 +39865,7 @@ paths: type: integer secrets: type: array - items: &318 + items: &325 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -39547,7 +39904,7 @@ paths: - updated_at - visibility examples: - default: &565 + default: &567 value: total_count: 2 secrets: @@ -39560,7 +39917,7 @@ paths: updated_at: '2020-01-11T11:59:22Z' visibility: all headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -39579,13 +39936,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: &566 + schema: &568 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -39614,7 +39971,7 @@ paths: - key_id - key examples: - default: &567 + default: &569 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -39637,23 +39994,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 responses: '200': description: Response content: application/json: - schema: *318 + schema: *325 examples: - default: &569 + default: &571 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -39673,8 +40030,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 requestBody: required: true content: @@ -39729,7 +40086,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -39755,8 +40112,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 responses: '204': description: Response @@ -39781,8 +40138,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 - *19 - *17 responses: @@ -39800,9 +40157,9 @@ paths: type: integer repositories: type: array - items: *274 + items: *281 examples: - default: *288 + default: *295 '404': *6 x-github: githubCloudOnly: false @@ -39824,8 +40181,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 requestBody: required: true content: @@ -39875,8 +40232,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 - name: repository_id in: path required: true @@ -39909,8 +40266,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 - name: repository_id in: path required: true @@ -39949,7 +40306,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *83 + - *87 responses: '200': description: OK @@ -40090,7 +40447,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *83 + - *87 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -40113,11 +40470,11 @@ paths: currently being billed. seats: type: array - items: *141 + items: *145 examples: - default: *142 + default: *146 headers: - Link: *43 + Link: *47 '500': *40 '401': *25 '403': *29 @@ -40151,7 +40508,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *83 + - *87 requestBody: content: application/json: @@ -40229,7 +40586,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *83 + - *87 requestBody: content: application/json: @@ -40309,7 +40666,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *83 + - *87 requestBody: content: application/json: @@ -40386,7 +40743,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *83 + - *87 requestBody: content: application/json: @@ -40467,7 +40824,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *83 + - *87 - 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`). @@ -40499,13 +40856,13 @@ paths: application/json: schema: type: array - items: *202 + items: *207 examples: - default: *203 + default: *208 '500': *40 '403': *29 '404': *6 - '422': *204 + '422': *209 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40527,7 +40884,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization parameters: - - *83 + - *87 - *17 - name: page description: Page token @@ -40671,7 +41028,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization parameters: - - *83 + - *87 - name: credential_id in: path required: true @@ -40702,7 +41059,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization parameters: - - *83 + - *87 responses: '200': description: Response - list of custom role names @@ -40717,7 +41074,7 @@ paths: type: integer custom_roles: type: array - items: *319 + items: *326 examples: default: value: @@ -40804,12 +41161,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - - *83 + - *87 requestBody: required: true content: application/json: - schema: &321 + schema: &328 type: object properties: name: @@ -40850,9 +41207,9 @@ paths: description: Response content: application/json: - schema: *319 + schema: *326 examples: - default: *320 + default: *327 '422': *15 '404': *6 x-github: @@ -40876,16 +41233,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - - *83 - - *137 + - *87 + - *141 responses: '200': description: Response content: application/json: - schema: *319 + schema: *326 examples: - default: *320 + default: *327 '404': *6 x-github: githubCloudOnly: true @@ -40907,13 +41264,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - - *83 - - *137 + - *87 + - *141 requestBody: required: true content: application/json: - schema: &322 + schema: &329 type: object properties: name: @@ -40951,9 +41308,9 @@ paths: description: Response content: application/json: - schema: *319 + schema: *326 examples: - default: *320 + default: *327 '422': *15 '404': *6 x-github: @@ -40977,8 +41334,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - - *83 - - *137 + - *87 + - *141 responses: '204': description: Response @@ -41006,12 +41363,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---create-a-custom-role parameters: - - *83 + - *87 requestBody: required: true content: application/json: - schema: *321 + schema: *328 examples: default: value: @@ -41025,9 +41382,9 @@ paths: description: Response content: application/json: - schema: *319 + schema: *326 examples: - default: *320 + default: *327 '422': *15 '404': *6 x-github: @@ -41057,16 +41414,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---get-a-custom-role parameters: - - *83 - - *137 + - *87 + - *141 responses: '200': description: Response content: application/json: - schema: *319 + schema: *326 examples: - default: *320 + default: *327 '404': *6 x-github: githubCloudOnly: true @@ -41094,13 +41451,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---update-a-custom-role parameters: - - *83 - - *137 + - *87 + - *141 requestBody: required: true content: application/json: - schema: *322 + schema: *329 examples: default: value: @@ -41115,9 +41472,9 @@ paths: description: Response content: application/json: - schema: *319 + schema: *326 examples: - default: *320 + default: *327 '422': *15 '404': *6 x-github: @@ -41147,8 +41504,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---delete-a-custom-role parameters: - - *83 - - *137 + - *87 + - *141 responses: '204': description: Response @@ -41176,12 +41533,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *83 - - *323 - - *324 - - *325 - - *326 - - *327 + - *87 + - *330 + - *331 + - *332 + - *333 + - *334 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -41219,11 +41576,11 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *328 - - *329 - - *106 - - *104 - - *105 + - *335 + - *336 + - *110 + - *108 + - *109 - *17 responses: '200': @@ -41232,9 +41589,9 @@ paths: application/json: schema: type: array - items: *330 + items: *337 examples: - default: *331 + default: *338 '304': *37 '400': *14 '403': *29 @@ -41260,7 +41617,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - - *83 + - *87 - *17 - *19 responses: @@ -41278,7 +41635,7 @@ paths: type: integer secrets: type: array - items: &332 + items: &339 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -41328,7 +41685,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41349,13 +41706,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: &595 + schema: &597 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -41372,7 +41729,7 @@ paths: - key_id - key examples: - default: &596 + default: &598 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -41395,14 +41752,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 responses: '200': description: Response content: application/json: - schema: *332 + schema: *339 examples: default: value: @@ -41430,8 +41787,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 requestBody: required: true content: @@ -41490,7 +41847,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -41514,8 +41871,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 responses: '204': description: Response @@ -41539,8 +41896,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 - *19 - *17 responses: @@ -41558,9 +41915,9 @@ paths: type: integer repositories: type: array - items: *274 + items: *281 examples: - default: *288 + default: *295 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41581,8 +41938,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 requestBody: required: true content: @@ -41632,8 +41989,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 - name: repository_id in: path required: true @@ -41664,8 +42021,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 - name: repository_id in: path required: true @@ -41701,8 +42058,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *83 - - &604 + - *87 + - &606 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -41710,7 +42067,7 @@ paths: required: false schema: type: string - - &605 + - &607 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -41718,7 +42075,7 @@ paths: required: false schema: type: string - - &606 + - &608 name: time_period description: |- The time period to filter by. @@ -41734,7 +42091,7 @@ paths: - week - month default: month - - &607 + - &609 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -41749,7 +42106,7 @@ paths: - denied - all default: all - - *300 + - *307 - *17 - *19 responses: @@ -41759,7 +42116,7 @@ paths: application/json: schema: type: array - items: &608 + items: &610 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -41915,7 +42272,7 @@ paths: format: uri example: https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &609 + default: &611 value: - id: 21 number: 42 @@ -42001,12 +42358,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *83 - - *300 - - *99 - - *100 - - *101 - - &610 + - *87 + - *307 + - *103 + - *104 + - *105 + - &612 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -42032,7 +42389,7 @@ paths: application/json: schema: type: array - items: &611 + items: &613 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -42142,7 +42499,7 @@ paths: type: array description: The responses to the dismissal request. nullable: true - items: *103 + items: *107 url: type: string format: uri @@ -42153,7 +42510,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &612 + default: &614 value: - id: 21 number: 42 @@ -42233,7 +42590,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -42241,7 +42598,7 @@ paths: application/json: schema: type: array - items: &376 + items: &383 title: Package description: A software package type: object @@ -42291,8 +42648,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *333 - required: *334 + properties: *340 + required: *341 nullable: true created_at: type: string @@ -42311,7 +42668,7 @@ paths: - created_at - updated_at examples: - default: &377 + default: &384 value: - id: 197 name: hello_docker @@ -42389,7 +42746,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - - *83 + - *87 - *17 - *19 responses: @@ -42399,7 +42756,7 @@ paths: application/json: schema: type: array - items: *239 + items: *244 examples: 200-response: value: @@ -42472,7 +42829,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - - *83 + - *87 - name: group_id description: The unique identifier of the group. in: path @@ -42498,7 +42855,7 @@ paths: description: Response content: application/json: - schema: &451 + schema: &459 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -42579,7 +42936,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &452 + default: &460 value: group_id: '123' group_name: Octocat admins @@ -42617,7 +42974,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-external-groups-available-to-an-organization parameters: - - *83 + - *87 - *17 - name: page description: Page token @@ -42634,7 +42991,7 @@ paths: description: Response content: application/json: - schema: &449 + schema: &457 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -42671,7 +43028,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &450 + default: &458 value: groups: - group_id: '123' @@ -42705,7 +43062,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - - *83 + - *87 - *17 - *19 responses: @@ -42715,7 +43072,7 @@ paths: application/json: schema: type: array - items: &357 + items: &364 title: Organization Invitation description: Organization Invitation type: object @@ -42762,7 +43119,7 @@ paths: - invitation_teams_url - node_id examples: - default: &358 + default: &365 value: - id: 1 login: monalisa @@ -42795,7 +43152,7 @@ paths: invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams invitation_source: member headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -42821,7 +43178,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -42829,7 +43186,7 @@ paths: application/json: schema: type: array - items: &409 + items: &416 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -42843,7 +43200,7 @@ paths: - name - description examples: - default: &410 + default: &417 value: - name: add_assignee description: Assign or remove a user @@ -42874,7 +43231,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - - *83 + - *87 - *17 - *19 responses: @@ -42884,7 +43241,7 @@ paths: application/json: schema: type: array - items: &335 + items: &342 title: Org Hook description: Org Hook type: object @@ -42972,7 +43329,7 @@ paths: created_at: '2011-09-06T17:26:27Z' type: Organization headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -42993,7 +43350,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - - *83 + - *87 requestBody: required: true content: @@ -43053,9 +43410,9 @@ paths: description: Response content: application/json: - schema: *335 + schema: *342 examples: - default: &336 + default: &343 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -43099,8 +43456,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - - *83 - - &337 + - *87 + - &344 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. @@ -43113,9 +43470,9 @@ paths: description: Response content: application/json: - schema: *335 + schema: *342 examples: - default: *336 + default: *343 '404': *6 x-github: githubCloudOnly: false @@ -43136,8 +43493,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - - *83 - - *337 + - *87 + - *344 requestBody: required: false content: @@ -43182,7 +43539,7 @@ paths: description: Response content: application/json: - schema: *335 + schema: *342 examples: default: value: @@ -43221,8 +43578,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *83 - - *337 + - *87 + - *344 responses: '204': description: Response @@ -43247,8 +43604,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *83 - - *337 + - *87 + - *344 responses: '200': description: Response @@ -43276,8 +43633,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *83 - - *337 + - *87 + - *344 requestBody: required: false content: @@ -43325,10 +43682,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *83 - - *337 + - *87 + - *344 - *17 - - *338 + - *345 responses: '200': description: Response @@ -43336,9 +43693,9 @@ paths: application/json: schema: type: array - items: *339 + items: *346 examples: - default: *340 + default: *347 '400': *14 '422': *15 x-github: @@ -43361,17 +43718,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *83 - - *337 + - *87 + - *344 - *16 responses: '200': description: Response content: application/json: - schema: *341 + schema: *348 examples: - default: *342 + default: *349 '400': *14 '422': *15 x-github: @@ -43394,8 +43751,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *83 - - *337 + - *87 + - *344 - *16 responses: '202': *39 @@ -43421,8 +43778,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *83 - - *337 + - *87 + - *344 responses: '204': description: Response @@ -43444,8 +43801,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *83 - - &347 + - *87 + - &354 name: actor_type in: path description: The type of the actor @@ -43458,14 +43815,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &348 + - &355 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &343 + - &350 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`.' @@ -43473,7 +43830,7 @@ paths: required: true schema: type: string - - &344 + - &351 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) @@ -43484,7 +43841,7 @@ paths: type: string - *19 - *17 - - *106 + - *110 - name: sort description: The property to sort the results by. in: query @@ -43566,13 +43923,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - - *83 - - *343 - - *344 + - *87 + - *350 + - *351 - *19 - *17 - - *106 - - &353 + - *110 + - &360 name: sort description: The property to sort the results by. in: query @@ -43650,15 +44007,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - - *83 - - *343 - - *344 + - *87 + - *350 + - *351 responses: '200': description: Response content: application/json: - schema: &345 + schema: &352 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -43674,7 +44031,7 @@ paths: type: integer format: int64 examples: - default: &346 + default: &353 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -43694,24 +44051,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *83 - - &349 + - *87 + - &356 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *343 - - *344 + - *350 + - *351 responses: '200': description: Response content: application/json: - schema: *345 + schema: *352 examples: - default: *346 + default: *353 x-github: enabledForGitHubApps: true category: orgs @@ -43729,19 +44086,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *83 - - *343 - - *344 - - *347 - - *348 + - *87 + - *350 + - *351 + - *354 + - *355 responses: '200': description: Response content: application/json: - schema: *345 + schema: *352 examples: - default: *346 + default: *353 x-github: enabledForGitHubApps: true category: orgs @@ -43758,10 +44115,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - - *83 - - *343 - - *344 - - &350 + - *87 + - *350 + - *351 + - &357 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -43774,7 +44131,7 @@ paths: description: Response content: application/json: - schema: &351 + schema: &358 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -43790,7 +44147,7 @@ paths: type: integer format: int64 examples: - default: &352 + default: &359 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -43826,19 +44183,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - - *83 - - *349 - - *343 - - *344 + - *87 + - *356 - *350 + - *351 + - *357 responses: '200': description: Response content: application/json: - schema: *351 + schema: *358 examples: - default: *352 + default: *359 x-github: enabledForGitHubApps: true category: orgs @@ -43855,20 +44212,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *83 - - *347 - - *348 - - *343 - - *344 + - *87 + - *354 + - *355 - *350 + - *351 + - *357 responses: '200': description: Response content: application/json: - schema: *351 + schema: *358 examples: - default: *352 + default: *359 x-github: enabledForGitHubApps: true category: orgs @@ -43885,14 +44242,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - - *83 - - *349 - - *343 - - *344 + - *87 + - *356 + - *350 + - *351 - *19 - *17 - - *106 - - *353 + - *110 + - *360 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -43965,7 +44322,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *83 + - *87 responses: '200': description: Response @@ -43973,7 +44330,7 @@ paths: application/json: schema: *22 examples: - default: &643 + default: &645 value: id: 1 account: @@ -44042,7 +44399,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *83 + - *87 - *17 - *19 responses: @@ -44112,7 +44469,7 @@ paths: suspended_at: suspended_by: headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44131,7 +44488,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -44139,12 +44496,12 @@ paths: application/json: schema: anyOf: - - &355 + - &362 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &354 + limit: &361 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -44169,7 +44526,7 @@ paths: properties: {} additionalProperties: false examples: - default: &356 + default: &363 value: limit: collaborators_only origin: organization @@ -44193,18 +44550,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: application/json: - schema: &644 + schema: &646 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *354 + limit: *361 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -44228,9 +44585,9 @@ paths: description: Response content: application/json: - schema: *355 + schema: *362 examples: - default: *356 + default: *363 '422': *15 x-github: githubCloudOnly: false @@ -44248,7 +44605,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *83 + - *87 responses: '204': description: Response @@ -44274,7 +44631,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - - *83 + - *87 - *17 - *19 - name: role @@ -44308,11 +44665,11 @@ paths: application/json: schema: type: array - items: *357 + items: *364 examples: - default: *358 + default: *365 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -44334,7 +44691,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - - *83 + - *87 requestBody: required: false content: @@ -44388,7 +44745,7 @@ paths: description: Response content: application/json: - schema: *357 + schema: *364 examples: default: value: @@ -44444,8 +44801,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - - *83 - - &359 + - *87 + - &366 name: invitation_id description: The unique identifier of the invitation. in: path @@ -44478,8 +44835,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - - *83 - - *359 + - *87 + - *366 - *17 - *19 responses: @@ -44489,9 +44846,9 @@ paths: application/json: schema: type: array - items: *303 + items: *310 examples: - default: &375 + default: &382 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -44507,7 +44864,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -44526,7 +44883,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -44534,7 +44891,7 @@ paths: application/json: schema: type: array - items: *360 + items: *367 examples: default: value: @@ -44572,7 +44929,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -44619,9 +44976,9 @@ paths: description: Response content: application/json: - schema: *360 + schema: *367 examples: - default: &361 + default: &368 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -44653,8 +45010,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *83 - - &362 + - *87 + - &369 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -44707,9 +45064,9 @@ paths: description: Response content: application/json: - schema: *360 + schema: *367 examples: - default: *361 + default: *368 '404': *6 '422': *7 x-github: @@ -44733,8 +45090,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *83 - - *362 + - *87 + - *369 responses: '204': description: Response @@ -44767,7 +45124,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *83 + - *87 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -44797,7 +45154,7 @@ paths: - closed - all default: open - - *363 + - *370 - name: type description: Can be the name of an issue type. in: query @@ -44815,8 +45172,8 @@ paths: - updated - comments default: created - - *106 - - *217 + - *110 + - *222 - *17 - *19 responses: @@ -44826,11 +45183,11 @@ paths: application/json: schema: type: array - items: *227 + items: *232 examples: - default: *364 + default: *371 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -44850,7 +45207,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - - *83 + - *87 - 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) @@ -44888,9 +45245,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 '422': *15 x-github: githubCloudOnly: false @@ -44908,8 +45265,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response if requester is an organization member and user is @@ -44943,8 +45300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response @@ -44970,8 +45327,8 @@ paths: parameters: - *17 - *19 - - *83 - - *138 + - *87 + - *142 responses: '200': description: Response @@ -44987,9 +45344,9 @@ paths: type: integer codespaces: type: array - items: *365 + items: *372 examples: - default: *366 + default: *373 '304': *37 '500': *40 '401': *25 @@ -45014,9 +45371,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *83 - - *138 - - &367 + - *87 + - *142 + - &374 name: codespace_name in: path required: true @@ -45049,17 +45406,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *83 - - *138 - - *367 + - *87 + - *142 + - *374 responses: '200': description: Response content: application/json: - schema: *365 + schema: *372 examples: - default: &562 + default: &564 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -45232,14 +45589,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *83 - - *138 + - *87 + - *142 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *141 + schema: *145 examples: default: value: @@ -45308,14 +45665,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - - *83 - - *138 + - *87 + - *142 responses: '200': description: Response content: application/json: - schema: &368 + schema: &375 title: Org Membership description: Org Membership type: object @@ -45359,7 +45716,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *69 + organization: *73 user: title: Simple User description: A GitHub user. @@ -45382,7 +45739,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &369 + response-if-user-has-an-active-admin-membership-with-organization: &376 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -45450,8 +45807,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - - *83 - - *138 + - *87 + - *142 requestBody: required: false content: @@ -45479,9 +45836,9 @@ paths: description: Response content: application/json: - schema: *368 + schema: *375 examples: - response-if-user-already-had-membership-with-organization: *369 + response-if-user-already-had-membership-with-organization: *376 '422': *15 '403': *29 x-github: @@ -45505,8 +45862,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response @@ -45531,7 +45888,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - - *83 + - *87 - *17 - *19 - name: exclude @@ -45552,7 +45909,7 @@ paths: application/json: schema: type: array - items: &370 + items: &377 title: Migration description: A migration. type: object @@ -45593,7 +45950,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *74 + items: *78 url: type: string format: uri @@ -45789,7 +46146,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -45805,7 +46162,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - - *83 + - *87 requestBody: required: true content: @@ -45881,7 +46238,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *377 examples: default: value: @@ -46059,8 +46416,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - - *83 - - &371 + - *87 + - &378 name: migration_id description: The unique identifier of the migration. in: path @@ -46087,7 +46444,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *370 + schema: *377 examples: default: value: @@ -46256,8 +46613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *83 - - *371 + - *87 + - *378 responses: '302': description: Response @@ -46278,8 +46635,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *83 - - *371 + - *87 + - *378 responses: '204': description: Response @@ -46302,9 +46659,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - - *83 - - *371 - - &818 + - *87 + - *378 + - &817 name: repo_name description: repo_name parameter in: path @@ -46331,8 +46688,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *83 - - *371 + - *87 + - *378 - *17 - *19 responses: @@ -46342,9 +46699,9 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: &382 + default: &389 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -46455,7 +46812,7 @@ paths: secret_scanning_validity_checks: status: disabled headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -46483,7 +46840,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -46537,7 +46894,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response - list of organization roles @@ -46553,7 +46910,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &372 + items: &379 title: Organization Role description: Organization roles type: object @@ -46713,7 +47070,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - - *83 + - *87 requestBody: required: true content: @@ -46760,7 +47117,7 @@ paths: description: Response content: application/json: - schema: *372 + schema: *379 examples: default: value: @@ -46789,7 +47146,7 @@ paths: updated_at: '2022-07-04T22:19:11Z' '422': *15 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -46811,8 +47168,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *83 - - *210 + - *87 + - *215 responses: '204': description: Response @@ -46837,9 +47194,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *83 - - *210 - - *137 + - *87 + - *215 + - *141 responses: '204': description: Response @@ -46868,9 +47225,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *83 - - *210 - - *137 + - *87 + - *215 + - *141 responses: '204': description: Response @@ -46895,8 +47252,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response @@ -46921,9 +47278,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *83 - - *138 - - *137 + - *87 + - *142 + - *141 responses: '204': description: Response @@ -46953,9 +47310,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *83 - - *138 - - *137 + - *87 + - *142 + - *141 responses: '204': description: Response @@ -46983,14 +47340,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - - *83 - - *137 + - *87 + - *141 responses: '200': description: Response content: application/json: - schema: *372 + schema: *379 examples: default: value: @@ -47047,8 +47404,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - - *83 - - *137 + - *87 + - *141 requestBody: required: true content: @@ -47087,7 +47444,7 @@ paths: description: Response content: application/json: - schema: *372 + schema: *379 examples: default: value: @@ -47115,7 +47472,7 @@ paths: created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': *15 - '409': *114 + '409': *118 '404': *6 x-github: githubCloudOnly: true @@ -47140,8 +47497,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - - *83 - - *137 + - *87 + - *141 responses: '204': description: Response @@ -47166,8 +47523,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *83 - - *137 + - *87 + - *141 - *17 - *19 responses: @@ -47245,8 +47602,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *373 - required: *374 + properties: *380 + required: *381 nullable: true type: description: The ownership type of the team @@ -47278,9 +47635,9 @@ paths: - type - parent examples: - default: *375 + default: *382 headers: - Link: *43 + Link: *47 '404': description: Response if the organization or role does not exist. '422': @@ -47307,8 +47664,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *83 - - *137 + - *87 + - *141 - *17 - *19 responses: @@ -47336,13 +47693,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &429 + items: &437 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *373 - required: *374 + properties: *380 + required: *381 name: nullable: true type: string @@ -47437,9 +47794,9 @@ paths: - type - url examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 '404': description: Response if the organization or role does not exist. '422': @@ -47461,7 +47818,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *83 + - *87 - 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) @@ -47488,9 +47845,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47513,8 +47870,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *83 - - *138 + - *87 + - *142 requestBody: required: false content: @@ -47571,8 +47928,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response @@ -47629,8 +47986,8 @@ paths: - docker - nuget - container - - *83 - - &819 + - *87 + - &818 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -47666,12 +48023,12 @@ paths: application/json: schema: type: array - items: *376 + items: *383 examples: - default: *377 + default: *384 '403': *29 '401': *25 - '400': &821 + '400': &820 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -47693,7 +48050,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &378 + - &385 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 @@ -47711,20 +48068,20 @@ paths: - docker - nuget - container - - &379 + - &386 name: package_name description: The name of the package. in: path required: true schema: type: string - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *376 + schema: *383 examples: default: value: @@ -47776,9 +48133,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *378 - - *379 - - *83 + - *385 + - *386 + - *87 responses: '204': description: Response @@ -47810,9 +48167,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *378 - - *379 - - *83 + - *385 + - *386 + - *87 - name: token description: package token schema: @@ -47844,9 +48201,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *378 - - *379 - - *83 + - *385 + - *386 + - *87 - *19 - *17 - name: state @@ -47866,7 +48223,7 @@ paths: application/json: schema: type: array - items: &380 + items: &387 title: Package Version description: A version of a software package type: object @@ -47991,10 +48348,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *378 - - *379 - - *83 - - &381 + - *385 + - *386 + - *87 + - &388 name: package_version_id description: Unique identifier of the package version. in: path @@ -48006,7 +48363,7 @@ paths: description: Response content: application/json: - schema: *380 + schema: *387 examples: default: value: @@ -48042,10 +48399,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *378 - - *379 - - *83 - - *381 + - *385 + - *386 + - *87 + - *388 responses: '204': description: Response @@ -48077,10 +48434,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *378 - - *379 - - *83 - - *381 + - *385 + - *386 + - *87 + - *388 responses: '204': description: Response @@ -48107,10 +48464,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *83 + - *87 - *17 - *19 - - &383 + - &390 name: sort description: The property by which to sort the results. in: query @@ -48120,8 +48477,8 @@ paths: enum: - created_at default: created_at - - *106 - - &384 + - *110 + - &391 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -48132,7 +48489,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &385 + - &392 name: repository description: The name of the repository to use to filter the results. in: query @@ -48140,7 +48497,7 @@ paths: schema: type: string example: Hello-World - - &386 + - &393 name: permission description: The permission to use to filter the results. in: query @@ -48148,7 +48505,7 @@ paths: schema: type: string example: issues_read - - &387 + - &394 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) @@ -48158,7 +48515,7 @@ paths: schema: type: string format: date-time - - &388 + - &395 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) @@ -48168,7 +48525,7 @@ paths: schema: type: string format: date-time - - &389 + - &396 name: token_id description: The ID of the token in: query @@ -48312,7 +48669,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48332,7 +48689,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *83 + - *87 requestBody: required: true content: @@ -48398,7 +48755,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *83 + - *87 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -48438,7 +48795,7 @@ paths: '422': *15 '404': *6 '403': *29 - '204': *150 + '204': *154 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48459,7 +48816,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *83 + - *87 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -48479,11 +48836,11 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: *382 + default: *389 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48504,17 +48861,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *83 + - *87 - *17 - *19 - - *383 - - *106 - - *384 - - *385 - - *386 - - *387 - - *388 - - *389 + - *390 + - *110 + - *391 + - *392 + - *393 + - *394 + - *395 + - *396 responses: '500': *40 '422': *15 @@ -48643,7 +49000,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48663,7 +49020,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *83 + - *87 requestBody: required: true content: @@ -48723,7 +49080,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *83 + - *87 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -48753,7 +49110,7 @@ paths: responses: '500': *40 '404': *6 - '204': *150 + '204': *154 '403': *29 '422': *15 x-github: @@ -48775,7 +49132,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *83 + - *87 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -48794,11 +49151,11 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: *382 + default: *389 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48820,7 +49177,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *83 + - *87 - *17 - *19 responses: @@ -48838,7 +49195,7 @@ paths: type: integer configurations: type: array - items: &390 + items: &397 title: Organization private registry description: Private registry configuration for an organization type: object @@ -48918,7 +49275,7 @@ paths: updated_at: '2020-01-10T14:59:22Z' visibility: selected headers: - Link: *43 + Link: *47 '400': *14 '404': *6 x-github: @@ -48940,7 +49297,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -49128,7 +49485,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &391 + org-private-registry-with-selected-visibility: &398 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -49169,7 +49526,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -49195,7 +49552,7 @@ paths: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -49217,16 +49574,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *83 - - *284 + - *87 + - *291 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *390 + schema: *397 examples: - default: *391 + default: *398 '404': *6 x-github: githubCloudOnly: false @@ -49247,8 +49604,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *83 - - *284 + - *87 + - *291 requestBody: required: true content: @@ -49352,8 +49709,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *83 - - *284 + - *87 + - *291 responses: '204': description: Response @@ -49376,15 +49733,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-organization parameters: - - *83 + - *87 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *104 - - *105 + - *108 + - *109 - *17 responses: '200': @@ -49393,7 +49750,7 @@ paths: application/json: schema: type: array - items: &392 + items: &399 title: Projects v2 Project description: A projects v2 project type: object @@ -49463,7 +49820,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &898 + properties: &906 id: type: number description: The unique identifier of the status update. @@ -49511,7 +49868,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &899 + required: &907 - id - node_id - created_at @@ -49536,7 +49893,7 @@ paths: - deleted_at - deleted_by examples: - default: &393 + default: &400 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -49619,7 +49976,7 @@ paths: updated_at: '2025-07-11T16:19:28Z' is_template: true headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -49639,24 +49996,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-organization parameters: - - &394 + - &401 name: project_number description: The project's number. in: path required: true schema: type: integer - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *392 + schema: *399 examples: - default: *393 + default: *400 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -49676,8 +50033,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - - *83 - - *394 + - *87 + - *401 requestBody: required: true description: Details of the draft item to create in the project. @@ -49711,7 +50068,7 @@ paths: description: Response content: application/json: - schema: &400 + schema: &407 title: Projects v2 Item description: An item belonging to a project type: object @@ -49724,8 +50081,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *227 - - &577 + - *232 + - &579 title: Pull Request Simple description: Pull Request Simple type: object @@ -49831,8 +50188,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *395 - required: *396 + properties: *402 + required: *403 nullable: true active_lock_reason: type: string @@ -49877,7 +50234,7 @@ paths: nullable: true requested_teams: type: array - items: *303 + items: *310 nullable: true head: type: object @@ -49886,7 +50243,7 @@ paths: type: string ref: type: string - repo: *74 + repo: *78 sha: type: string user: @@ -49909,7 +50266,7 @@ paths: type: string ref: type: string - repo: *74 + repo: *78 sha: type: string user: @@ -49928,7 +50285,7 @@ paths: _links: type: object properties: - comments: &397 + comments: &404 title: Link description: Hypermedia Link type: object @@ -49937,13 +50294,13 @@ paths: type: string required: - href - commits: *397 - statuses: *397 - html: *397 - issue: *397 - review_comments: *397 - review_comment: *397 - self: *397 + commits: *404 + statuses: *404 + html: *404 + issue: *404 + review_comments: *404 + review_comment: *404 + self: *404 required: - comments - commits @@ -49953,8 +50310,8 @@ paths: - review_comments - review_comment - self - author_association: *214 - auto_merge: &692 + author_association: *219 + auto_merge: &694 title: Auto merge description: The status of auto merging a pull request. type: object @@ -50056,7 +50413,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &399 + content_type: &406 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -50096,7 +50453,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &401 + draft_issue: &408 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -50170,11 +50527,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-organization parameters: - - *394 - - *83 + - *401 + - *87 - *17 - - *104 - - *105 + - *108 + - *109 responses: '200': description: Response @@ -50182,7 +50539,7 @@ paths: application/json: schema: type: array - items: &398 + items: &405 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -50329,7 +50686,7 @@ paths: - updated_at - project_url examples: - default: &838 + default: &837 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -50440,10 +50797,300 @@ paths: created_at: '2022-06-20T16:45:00Z' updated_at: '2022-06-20T16:45:00Z' headers: - Link: *43 + Link: *47 + '304': *37 + '403': *29 + '401': *25 + 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/enterprise-cloud@latest//rest/projects/fields#add-a-field-to-an-organization-owned-project + parameters: + - *401 + - *87 + 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: &838 + 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: &839 + 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: &840 + 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: &841 + 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: *405 + examples: + text_field: &842 + 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: &843 + 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: &844 + 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: &845 + 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: &846 + 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': *37 '403': *29 '401': *25 + '422': *15 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50460,23 +51107,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - - *394 - - &839 + - *401 + - &847 name: field_id description: The unique identifier of the field. in: path required: true schema: type: integer - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *398 + schema: *405 examples: - default: &840 + default: &848 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -50485,21 +51132,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: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -50520,8 +51179,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *394 - - *83 + - *401 + - *87 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. @@ -50543,8 +51202,8 @@ paths: maxItems: 50 items: type: string - - *104 - - *105 + - *108 + - *109 - *17 responses: '200': @@ -50553,7 +51212,7 @@ paths: application/json: schema: type: array - items: &402 + items: &409 title: Projects v2 Item description: An item belonging to a project type: object @@ -50569,7 +51228,7 @@ paths: format: uri example: https://api.github.com/users/monalisa/2/projectsV2/3 description: The API URL of the project that contains this item. - content_type: *399 + content_type: *406 content: type: object additionalProperties: true @@ -50612,7 +51271,7 @@ paths: - updated_at - archived_at examples: - default: &403 + default: &410 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -51288,7 +51947,7 @@ paths: type: sub_issues_progress value: headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -51308,8 +51967,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-organization-owned-project parameters: - - *83 - - *394 + - *87 + - *401 requestBody: required: true description: Details of the item to add to the project. @@ -51346,10 +52005,10 @@ paths: description: Response content: application/json: - schema: *400 + schema: *407 examples: - issue: *401 - pull_request: *401 + issue: *408 + pull_request: *408 '304': *37 '403': *29 '401': *25 @@ -51369,9 +52028,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *394 - - *83 - - &404 + - *401 + - *87 + - &411 name: item_id description: The unique identifier of the project item. in: path @@ -51397,11 +52056,11 @@ paths: description: Response content: application/json: - schema: *402 + schema: *409 examples: - default: *403 + default: *410 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -51420,9 +52079,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-organization parameters: - - *394 - - *83 - - *404 + - *401 + - *87 + - *411 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -51492,13 +52151,13 @@ paths: description: Response content: application/json: - schema: *402 + schema: *409 examples: - text_field: *403 - number_field: *403 - date_field: *403 - single_select_field: *403 - iteration_field: *403 + text_field: *410 + number_field: *410 + date_field: *410 + single_select_field: *410 + iteration_field: *410 '401': *25 '403': *29 '404': *6 @@ -51518,9 +52177,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-organization parameters: - - *394 - - *83 - - *404 + - *401 + - *87 + - *411 responses: '204': description: Response @@ -51544,7 +52203,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -51552,9 +52211,9 @@ paths: application/json: schema: type: array - items: *152 + items: *156 examples: - default: *153 + default: *157 '403': *29 '404': *6 x-github: @@ -51581,7 +52240,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -51592,7 +52251,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *152 + items: *156 minItems: 1 maxItems: 100 required: @@ -51622,9 +52281,9 @@ paths: application/json: schema: type: array - items: *152 + items: *156 examples: - default: *153 + default: *157 '403': *29 '404': *6 x-github: @@ -51645,16 +52304,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *83 - - *148 + - *87 + - *152 responses: '200': description: Response content: application/json: - schema: *152 + schema: *156 examples: - default: *154 + default: *158 '403': *29 '404': *6 x-github: @@ -51677,13 +52336,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *83 - - *148 + - *87 + - *152 requestBody: required: true content: application/json: - schema: *405 + schema: *412 examples: default: value: @@ -51699,9 +52358,9 @@ paths: description: Response content: application/json: - schema: *152 + schema: *156 examples: - default: *154 + default: *158 '403': *29 '404': *6 x-github: @@ -51724,10 +52383,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *83 - - *148 + - *87 + - *152 responses: - '204': *150 + '204': *154 '403': *29 '404': *6 x-github: @@ -51748,7 +52407,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *83 + - *87 - *17 - *19 - name: repository_query @@ -51786,7 +52445,7 @@ paths: example: octocat/Hello-World properties: type: array - items: *151 + items: *155 description: List of custom property names and associated values required: - repository_id @@ -51807,7 +52466,7 @@ paths: - property_name: team value: octocat headers: - Link: *43 + Link: *47 '403': *29 '404': *6 x-github: @@ -51835,7 +52494,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *83 + - *87 requestBody: required: true content: @@ -51855,7 +52514,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *151 + items: *155 required: - repository_names - properties @@ -51896,7 +52555,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - - *83 + - *87 - *17 - *19 responses: @@ -51908,9 +52567,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51927,8 +52586,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response if user is a public member @@ -51952,8 +52611,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response @@ -51974,8 +52633,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response @@ -51999,7 +52658,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - - *83 + - *87 - name: type description: Specifies the types of repositories you want returned. `internal` is not yet supported when a GitHub App calls this endpoint with an installation @@ -52046,11 +52705,11 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: *382 + default: *389 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52069,7 +52728,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - - *83 + - *87 requestBody: required: true content: @@ -52528,8 +53187,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *406 - required: *407 + properties: *413 + required: *414 nullable: true temp_clone_token: type: string @@ -52616,8 +53275,8 @@ paths: title: License Simple description: License Simple type: object - properties: *228 - required: *229 + properties: *233 + required: *234 nullable: true organization: title: Simple User @@ -52626,8 +53285,8 @@ paths: properties: *20 required: *21 nullable: true - parent: *74 - source: *74 + parent: *78 + source: *78 forks: type: integer master_branch: @@ -52644,7 +53303,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &582 + properties: &584 url: type: string format: uri @@ -52660,12 +53319,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &583 + required: &585 - url - key - name - html_url - security_and_analysis: *408 + security_and_analysis: *415 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -53267,7 +53926,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -53275,9 +53934,9 @@ paths: application/json: schema: type: array - items: *409 + items: *416 examples: - default: *410 + default: *417 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -53299,10 +53958,10 @@ paths: category: orgs subcategory: rules parameters: - - *83 + - *87 - *17 - *19 - - &715 + - &716 name: targets description: | A comma-separated list of rule targets to filter by. @@ -53320,7 +53979,7 @@ paths: application/json: schema: type: array - items: *185 + items: *190 examples: default: value: @@ -53367,7 +54026,7 @@ paths: category: orgs subcategory: rules parameters: - - *83 + - *87 requestBody: description: Request body required: true @@ -53388,24 +54047,20 @@ paths: - push - repository default: branch - enforcement: *163 + enforcement: *167 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *164 - conditions: *411 + items: *168 + conditions: *418 rules: type: array description: An array of rules within the ruleset. - items: &413 + items: &420 title: Repository Rule type: object description: A repository rule. oneOf: - - *165 - - *166 - - *167 - - *168 - *169 - *170 - *171 @@ -53422,6 +54077,11 @@ paths: - *182 - *183 - *184 + - *185 + - *186 + - *187 + - *188 + - *189 required: - name - enforcement @@ -53459,9 +54119,9 @@ paths: description: Response content: application/json: - schema: *185 + schema: *190 examples: - default: &412 + default: &419 value: id: 21 name: super cool ruleset @@ -53515,8 +54175,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *83 - - &717 + - *87 + - &718 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 @@ -53526,16 +54186,16 @@ paths: schema: type: string x-multi-segment: true - - *300 - - *101 - - &718 + - *307 + - *105 + - &719 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 - - &719 + - &720 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -53555,7 +54215,7 @@ paths: description: Response content: application/json: - schema: &720 + schema: &721 title: Rule Suites description: Response type: array @@ -53610,7 +54270,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &721 + default: &722 value: - id: 21 actor_id: 12 @@ -53653,8 +54313,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *83 - - &722 + - *87 + - &723 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -53670,7 +54330,7 @@ paths: description: Response content: application/json: - schema: &723 + schema: &724 title: Rule Suite description: Response type: object @@ -53769,7 +54429,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &724 + default: &725 value: id: 21 actor_id: 12 @@ -53830,7 +54490,7 @@ paths: category: orgs subcategory: rules parameters: - - *83 + - *87 - name: ruleset_id description: The ID of the ruleset. in: path @@ -53842,9 +54502,9 @@ paths: description: Response content: application/json: - schema: *185 + schema: *190 examples: - default: *412 + default: *419 '404': *6 '500': *40 put: @@ -53862,7 +54522,7 @@ paths: category: orgs subcategory: rules parameters: - - *83 + - *87 - name: ruleset_id description: The ID of the ruleset. in: path @@ -53888,16 +54548,16 @@ paths: - tag - push - repository - enforcement: *163 + enforcement: *167 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *164 - conditions: *411 + items: *168 + conditions: *418 rules: description: An array of rules within the ruleset. type: array - items: *413 + items: *420 examples: default: value: @@ -53932,9 +54592,9 @@ paths: description: Response content: application/json: - schema: *185 + schema: *190 examples: - default: *412 + default: *419 '404': *6 '500': *40 delete: @@ -53952,7 +54612,7 @@ paths: category: orgs subcategory: rules parameters: - - *83 + - *87 - name: ruleset_id description: The ID of the ruleset. in: path @@ -53975,7 +54635,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-history parameters: - - *83 + - *87 - *17 - *19 - name: ruleset_id @@ -53991,9 +54651,9 @@ paths: application/json: schema: type: array - items: *189 + items: *194 examples: - default: *414 + default: *421 '404': *6 '500': *40 x-github: @@ -54012,7 +54672,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-version parameters: - - *83 + - *87 - name: ruleset_id description: The ID of the ruleset. in: path @@ -54030,7 +54690,7 @@ paths: description: Response content: application/json: - schema: *415 + schema: *422 examples: default: value: @@ -54092,15 +54752,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *83 - - *416 - - *417 - - *418 - - *419 - - *106 + - *87 + - *423 + - *424 + - *425 + - *426 + - *427 + - *110 - *19 - *17 - - &726 + - &727 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -54110,7 +54771,7 @@ paths: required: false schema: type: string - - &727 + - &728 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -54120,10 +54781,10 @@ paths: required: false schema: type: string - - *420 - - *421 - - *422 - - *423 + - *428 + - *429 + - *430 + - *431 responses: '200': description: Response @@ -54131,13 +54792,13 @@ paths: application/json: schema: type: array - items: *424 + items: *432 examples: - default: *425 + default: *433 headers: - Link: *43 + Link: *47 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54162,15 +54823,15 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *426 + schema: *434 examples: - default: *427 + default: *435 '403': *29 '404': *6 patch: @@ -54191,7 +54852,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *83 + - *87 requestBody: required: true content: @@ -54199,7 +54860,7 @@ paths: schema: type: object properties: - pattern_config_version: *192 + pattern_config_version: *197 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -54225,7 +54886,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *192 + custom_pattern_version: *197 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -54261,7 +54922,7 @@ paths: '400': *14 '403': *29 '404': *6 - '409': *114 + '409': *118 '422': *15 "/orgs/{org}/security-advisories": get: @@ -54279,8 +54940,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *83 - - *106 + - *87 + - *110 - name: sort description: The property to sort the results by. in: query @@ -54292,8 +54953,8 @@ paths: - updated - published default: created - - *104 - - *105 + - *108 + - *109 - name: per_page description: The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -54323,7 +54984,7 @@ paths: application/json: schema: type: array - items: &748 + items: &749 description: A repository security advisory. type: object properties: @@ -54510,7 +55171,7 @@ paths: required: - vector_string - score - cvss_severities: *125 + cvss_severities: *129 cwes: type: array nullable: true @@ -54543,7 +55204,7 @@ paths: login: type: string description: The username of the user credited. - type: *428 + type: *436 credits_detailed: type: array nullable: true @@ -54553,7 +55214,7 @@ paths: type: object properties: user: *4 - type: *428 + type: *436 state: type: string description: The state of the user's acceptance of the @@ -54577,14 +55238,14 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *303 + items: *310 private_fork: readOnly: true nullable: true description: A temporary private fork of the advisory's repository for collaborating on a fix. allOf: - - *115 + - *119 required: - ghsa_id - cve_id @@ -54614,7 +55275,7 @@ paths: - private_fork additionalProperties: false examples: - default: &749 + default: &750 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -54993,7 +55654,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - - *83 + - *87 responses: '200': description: Response @@ -55001,9 +55662,9 @@ paths: application/json: schema: type: array - items: *429 + items: *437 examples: - default: *375 + default: *382 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55026,8 +55687,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - - *83 - - *210 + - *87 + - *215 responses: '204': description: Response @@ -55052,8 +55713,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *83 - - *210 + - *87 + - *215 responses: '204': description: Response @@ -55084,8 +55745,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - - *83 - - *430 + - *87 + - *438 - *17 - *19 responses: @@ -55093,9 +55754,9 @@ paths: description: Success content: application/json: - schema: *431 + schema: *439 examples: - default: *432 + default: *440 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -55115,7 +55776,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Immutable releases settings response @@ -55164,7 +55825,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#set-immutable-releases-settings-for-an-organization parameters: - - *83 + - *87 responses: '204': description: Response @@ -55221,7 +55882,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - - *83 + - *87 - *19 - *17 responses: @@ -55239,9 +55900,9 @@ paths: type: integer repositories: type: array - items: *274 + items: *281 examples: - default: *288 + default: *295 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55260,7 +55921,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement parameters: - - *83 + - *87 requestBody: required: true content: @@ -55309,8 +55970,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - - *83 - - *268 + - *87 + - *275 responses: '204': description: Response @@ -55332,8 +55993,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - - *83 - - *268 + - *87 + - *275 responses: '204': description: Response @@ -55356,7 +56017,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *83 + - *87 - *17 - *19 responses: @@ -55374,11 +56035,11 @@ paths: type: integer network_configurations: type: array - items: *143 + items: *147 examples: - default: *433 + default: *441 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55397,7 +56058,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -55439,9 +56100,9 @@ paths: description: Response content: application/json: - schema: *143 + schema: *147 examples: - default: *144 + default: *148 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55461,18 +56122,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - - *83 - - *145 + - *87 + - *149 responses: '200': description: Response content: application/json: - schema: *143 + schema: *147 examples: - default: *144 + default: *148 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55491,8 +56152,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - - *83 - - *145 + - *87 + - *149 requestBody: required: true content: @@ -55531,9 +56192,9 @@ paths: description: Response content: application/json: - schema: *143 + schema: *147 examples: - default: *144 + default: *148 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55552,8 +56213,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - - *83 - - *145 + - *87 + - *149 responses: '204': description: Response @@ -55576,18 +56237,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - - *83 - - *434 + - *87 + - *442 responses: '200': description: Response content: application/json: - schema: *435 + schema: *443 examples: - default: *436 + default: *444 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55604,7 +56265,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-an-organization parameters: - - *83 + - *87 - *17 - name: page description: Page token @@ -55623,7 +56284,7 @@ paths: description: Response content: application/json: - schema: &458 + schema: &464 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -55669,7 +56330,7 @@ paths: type: string nullable: true examples: - default: &459 + default: &465 value: groups: - group_id: '123' @@ -55714,8 +56375,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *83 - - *210 + - *87 + - *215 - 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`). @@ -55747,13 +56408,13 @@ paths: application/json: schema: type: array - items: *202 + items: *207 examples: - default: *203 + default: *208 '500': *40 '403': *29 '404': *6 - '422': *204 + '422': *209 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55771,7 +56432,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - - *83 + - *87 - *17 - *19 responses: @@ -55781,11 +56442,11 @@ paths: application/json: schema: type: array - items: *303 + items: *310 examples: - default: *375 + default: *382 headers: - Link: *43 + Link: *47 '403': *29 x-github: githubCloudOnly: false @@ -55805,7 +56466,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - - *83 + - *87 requestBody: required: true content: @@ -55877,7 +56538,7 @@ paths: description: Response content: application/json: - schema: &437 + schema: &445 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -55940,8 +56601,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *373 - required: *374 + properties: *380 + required: *381 nullable: true members_count: type: integer @@ -56204,7 +56865,7 @@ paths: - repos_count - organization examples: - default: &438 + default: &446 value: id: 1 node_id: MDQ6VGVhbTE= @@ -56274,16 +56935,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - - *83 - - *210 + - *87 + - *215 responses: '200': description: Response content: application/json: - schema: *437 + schema: *445 examples: - default: *438 + default: *446 '404': *6 x-github: githubCloudOnly: false @@ -56304,8 +56965,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - - *83 - - *210 + - *87 + - *215 requestBody: required: false content: @@ -56367,16 +57028,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *437 + schema: *445 examples: - default: *438 + default: *446 '201': description: Response content: application/json: - schema: *437 + schema: *445 examples: - default: *438 + default: *446 '404': *6 '422': *15 '403': *29 @@ -56401,8 +57062,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - - *83 - - *210 + - *87 + - *215 responses: '204': description: Response @@ -56428,9 +57089,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - - *83 - - *210 - - *106 + - *87 + - *215 + - *110 - *17 - *19 - name: pinned @@ -56446,7 +57107,7 @@ paths: application/json: schema: type: array - items: &439 + items: &447 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -56525,7 +57186,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *215 + reactions: *220 required: - author - body @@ -56545,7 +57206,7 @@ paths: - updated_at - url examples: - default: &792 + default: &793 value: - author: login: octocat @@ -56595,7 +57256,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56619,8 +57280,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - - *83 - - *210 + - *87 + - *215 requestBody: required: true content: @@ -56654,9 +57315,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *447 examples: - default: &440 + default: &448 value: author: login: octocat @@ -56728,9 +57389,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - - *83 - - *210 - - &441 + - *87 + - *215 + - &449 name: discussion_number description: The number that identifies the discussion. in: path @@ -56742,9 +57403,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *447 examples: - default: *440 + default: *448 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56766,9 +57427,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - - *83 - - *210 - - *441 + - *87 + - *215 + - *449 requestBody: required: false content: @@ -56791,9 +57452,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *447 examples: - default: &793 + default: &794 value: author: login: octocat @@ -56863,9 +57524,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - - *83 - - *210 - - *441 + - *87 + - *215 + - *449 responses: '204': description: Response @@ -56891,10 +57552,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - - *83 - - *210 - - *441 - - *106 + - *87 + - *215 + - *449 + - *110 - *17 - *19 responses: @@ -56904,7 +57565,7 @@ paths: application/json: schema: type: array - items: &442 + items: &450 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -56961,7 +57622,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *215 + reactions: *220 required: - author - body @@ -56976,7 +57637,7 @@ paths: - updated_at - url examples: - default: &794 + default: &795 value: - author: login: octocat @@ -57020,7 +57681,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57044,9 +57705,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *83 - - *210 - - *441 + - *87 + - *215 + - *449 requestBody: required: true content: @@ -57068,9 +57729,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *450 examples: - default: &443 + default: &451 value: author: login: octocat @@ -57136,10 +57797,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *83 - - *210 - - *441 - - &444 + - *87 + - *215 + - *449 + - &452 name: comment_number description: The number that identifies the comment. in: path @@ -57151,9 +57812,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *450 examples: - default: *443 + default: *451 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57175,10 +57836,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *83 - - *210 - - *441 - - *444 + - *87 + - *215 + - *449 + - *452 requestBody: required: true content: @@ -57200,9 +57861,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *450 examples: - default: &795 + default: &796 value: author: login: octocat @@ -57266,10 +57927,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *83 - - *210 - - *441 - - *444 + - *87 + - *215 + - *449 + - *452 responses: '204': description: Response @@ -57295,10 +57956,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *83 - - *210 - - *441 - - *444 + - *87 + - *215 + - *449 + - *452 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -57324,7 +57985,7 @@ paths: application/json: schema: type: array - items: &445 + items: &453 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -57367,7 +58028,7 @@ paths: - content - created_at examples: - default: &447 + default: &455 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57393,7 +58054,7 @@ paths: content: heart created_at: '2016-05-20T20:09:31Z' headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57417,10 +58078,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *83 - - *210 - - *441 - - *444 + - *87 + - *215 + - *449 + - *452 requestBody: required: true content: @@ -57453,9 +58114,9 @@ paths: team discussion comment content: application/json: - schema: *445 + schema: *453 examples: - default: &446 + default: &454 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57484,9 +58145,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57509,11 +58170,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *83 - - *210 - - *441 - - *444 - - &448 + - *87 + - *215 + - *449 + - *452 + - &456 name: reaction_id description: The unique identifier of the reaction. in: path @@ -57545,9 +58206,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *83 - - *210 - - *441 + - *87 + - *215 + - *449 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -57573,11 +58234,11 @@ paths: application/json: schema: type: array - items: *445 + items: *453 examples: - default: *447 + default: *455 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57601,9 +58262,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *83 - - *210 - - *441 + - *87 + - *215 + - *449 requestBody: required: true content: @@ -57635,16 +58296,16 @@ paths: description: Response content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '201': description: Response content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57667,10 +58328,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *83 - - *210 - - *441 - - *448 + - *87 + - *215 + - *449 + - *456 responses: '204': description: Response @@ -57693,16 +58354,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team parameters: - - *83 - - *210 + - *87 + - *215 responses: '200': description: Response content: application/json: - schema: *449 + schema: *457 examples: - default: *450 + default: *458 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -57721,8 +58382,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team parameters: - - *83 - - *210 + - *87 + - *215 requestBody: required: true content: @@ -57745,9 +58406,9 @@ paths: description: Response content: application/json: - schema: *451 + schema: *459 examples: - default: *452 + default: *460 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -57766,8 +58427,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team parameters: - - *83 - - *210 + - *87 + - *215 responses: '204': description: Response @@ -57791,8 +58452,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - - *83 - - *210 + - *87 + - *215 - *17 - *19 responses: @@ -57802,11 +58463,11 @@ paths: application/json: schema: type: array - items: *357 + items: *364 examples: - default: *358 + default: *365 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57826,8 +58487,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - - *83 - - *210 + - *87 + - *215 - name: role description: Filters members returned by their role in the team. in: query @@ -57850,9 +58511,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57880,15 +58541,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - - *83 - - *210 - - *138 + - *87 + - *215 + - *142 responses: '200': description: Response content: application/json: - schema: &453 + schema: &461 title: Team Membership description: Team Membership type: object @@ -57915,7 +58576,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &796 + response-if-user-is-a-team-maintainer: &797 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -57951,9 +58612,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *83 - - *210 - - *138 + - *87 + - *215 + - *142 requestBody: required: false content: @@ -57978,9 +58639,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *461 examples: - response-if-users-membership-with-team-is-now-pending: &797 + response-if-users-membership-with-team-is-now-pending: &798 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -58015,9 +58676,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - - *83 - - *210 - - *138 + - *87 + - *215 + - *142 responses: '204': description: Response @@ -58028,322 +58689,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/enterprise-cloud@latest//rest/teams/teams#list-team-projects - parameters: - - *83 - - *210 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &454 - 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 - nullable: true - 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: &798 - 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: *43 - 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/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project - parameters: - - *83 - - *210 - - &455 - 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: *454 - examples: - default: &799 - 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/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions - parameters: - - *83 - - *210 - - *455 - 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/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - nullable: true - 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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team - parameters: - - *83 - - *210 - - *455 - 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 @@ -58359,8 +58704,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - - *83 - - *210 + - *87 + - *215 - *17 - *19 responses: @@ -58370,11 +58715,11 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: *382 + default: *389 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58401,16 +58746,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *83 - - *210 - - *456 - - *457 + - *87 + - *215 + - *462 + - *463 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &800 + schema: &799 title: Team Repository description: A team's access to a repository. type: object @@ -58433,8 +58778,8 @@ paths: title: License Simple description: License Simple type: object - properties: *228 - required: *229 + properties: *233 + required: *234 nullable: true forks: type: integer @@ -58979,10 +59324,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *83 - - *210 - - *456 - - *457 + - *87 + - *215 + - *462 + - *463 requestBody: required: false content: @@ -59027,10 +59372,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - - *83 - - *210 - - *456 - - *457 + - *87 + - *215 + - *462 + - *463 responses: '204': description: Response @@ -59056,16 +59401,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team parameters: - - *83 - - *210 + - *87 + - *215 responses: '200': description: Response content: application/json: - schema: *458 + schema: *464 examples: - default: *459 + default: *465 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -59087,8 +59432,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections parameters: - - *83 - - *210 + - *87 + - *215 requestBody: required: true content: @@ -59131,7 +59476,7 @@ paths: description: Response content: application/json: - schema: *458 + schema: *464 examples: default: value: @@ -59163,8 +59508,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - - *83 - - *210 + - *87 + - *215 - *17 - *19 responses: @@ -59174,9 +59519,9 @@ paths: application/json: schema: type: array - items: *303 + items: *310 examples: - response-if-child-teams-exist: &801 + response-if-child-teams-exist: &800 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -59204,7 +59549,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59229,7 +59574,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *83 + - *87 - name: security_product in: path description: The security feature to enable or disable. @@ -59289,979 +59634,6 @@ paths: deprecationDate: '2024-07-22' removalDate: '2025-07-22' deprecated: true - "/projects/columns/cards/{card_id}": - get: - summary: Get a project card - 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-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card - parameters: - - &460 - name: card_id - description: The unique identifier of the card. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: &461 - title: Project Card - description: Project cards represent a scope of work. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/cards/1478 - id: - description: The project card's ID - example: 42 - type: integer - format: int64 - node_id: - type: string - example: MDExOlByb2plY3RDYXJkMTQ3OA== - note: - type: string - example: Add payload for delete Project column - nullable: true - creator: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - created_at: - type: string - format: date-time - example: '2016-09-05T14:21:06Z' - updated_at: - type: string - format: date-time - example: '2016-09-05T14:20:22Z' - archived: - description: Whether or not the card is archived - example: false - type: boolean - column_name: - type: string - project_id: - type: string - column_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - content_url: - type: string - format: uri - example: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - required: - - id - - node_id - - note - - url - - column_url - - project_url - - creator - - created_at - - updated_at - examples: - default: &462 - value: - url: https://api.github.com/projects/columns/cards/1478 - id: 1478 - node_id: MDExOlByb2plY3RDYXJkMTQ3OA== - note: Add payload for delete Project column - 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: '2016-09-05T14:21:06Z' - updated_at: '2016-09-05T14:20:22Z' - archived: false - column_url: https://api.github.com/projects/columns/367 - content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: https://api.github.com/projects/120 - '304': *37 - '403': *29 - '401': *25 - '404': *6 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update an existing project card - 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-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card - parameters: - - *460 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - note: - description: The project card's note - example: Update all gems - type: string - nullable: true - archived: - description: Whether or not the card is archived - example: false - type: boolean - examples: - default: - summary: Change the note on the card - value: - note: Add payload for delete Project column - responses: - '200': - description: Response - content: - application/json: - schema: *461 - examples: - default: *462 - '304': *37 - '403': *29 - '401': *25 - '404': *6 - '422': *7 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete a project card - 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-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card - parameters: - - *460 - responses: - '204': - description: Response - '304': *37 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *25 - '404': *6 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/cards/{card_id}/moves": - post: - summary: Move a project card - 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-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card - parameters: - - *460 - requestBody: - required: true - content: - application/json: - schema: - properties: - position: - description: 'The position of the card in a column. Can be one of: - `top`, `bottom`, or `after:` to place after the specified - card.' - example: bottom - type: string - pattern: "^(?:top|bottom|after:\\d+)$" - column_id: - description: The unique identifier of the column the card should - be moved to - example: 42 - type: integer - required: - - position - type: object - examples: - default: - summary: Move the card to the bottom of the column - value: - column_id: 42 - position: bottom - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': *37 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: object - properties: - code: - type: string - message: - type: string - resource: - type: string - field: - type: string - '401': *25 - '503': - description: Response - content: - application/json: - schema: - type: object - properties: - code: - type: string - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: object - properties: - code: - type: string - message: - type: string - '422': *15 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - 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/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column - parameters: - - &463 - 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: &464 - title: Project Column - description: Project columns contain cards of work. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - cards_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - example: 42 - type: integer - node_id: - type: string - example: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - example: Remaining tasks - type: string - created_at: - type: string - format: date-time - example: '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - example: '2016-09-05T14:22:28Z' - required: - - id - - node_id - - url - - project_url - - cards_url - - name - - created_at - - updated_at - examples: - default: &465 - 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': *37 - '403': *29 - '404': *6 - '401': *25 - 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/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column - parameters: - - *463 - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project column - example: Remaining tasks - type: string - required: - - name - type: object - examples: - default: - summary: Rename the project column - value: - name: To Do - responses: - '200': - description: Response - content: - application/json: - schema: *464 - examples: - default: *465 - '304': *37 - '403': *29 - '401': *25 - 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/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column - parameters: - - *463 - responses: - '204': - description: Response - '304': *37 - '403': *29 - '401': *25 - 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}/cards": - get: - summary: List project cards - 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-cards - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards - parameters: - - *463 - - name: archived_state - description: Filters the project cards that are returned by the card's state. - in: query - required: false - schema: - type: string - enum: - - all - - archived - - not_archived - default: not_archived - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *461 - examples: - default: - value: - - url: https://api.github.com/projects/columns/cards/1478 - id: 1478 - node_id: MDExOlByb2plY3RDYXJkMTQ3OA== - note: Add payload for delete Project column - 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: '2016-09-05T14:21:06Z' - updated_at: '2016-09-05T14:20:22Z' - archived: false - column_url: https://api.github.com/projects/columns/367 - content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: https://api.github.com/projects/120 - headers: - Link: *43 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create a project card - 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/create-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card - parameters: - - *463 - requestBody: - required: true - content: - application/json: - schema: - oneOf: - - type: object - properties: - note: - description: The project card's note - example: Update all gems - type: string - nullable: true - required: - - note - - type: object - properties: - content_id: - description: The unique identifier of the content associated with - the card - example: 42 - type: integer - content_type: - description: The piece of content associated with the card - example: PullRequest - type: string - required: - - content_id - - content_type - examples: - default: - summary: Create a new card - value: - note: Add payload for delete Project column - responses: - '201': - description: Response - content: - application/json: - schema: *461 - examples: - default: *462 - '304': *37 - '403': *29 - '401': *25 - '422': - description: Validation failed - content: - application/json: - schema: - oneOf: - - *249 - - *250 - '503': - description: Response - content: - application/json: - schema: - type: object - properties: - code: - type: string - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: object - properties: - code: - type: string - message: - type: string - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - 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/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column - parameters: - - *463 - 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.' - example: last - type: string - pattern: "^(?:first|last|after:\\d+)$" - 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': *37 - '403': *29 - '422': *7 - '401': *25 - 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/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators - parameters: - - *455 - - 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: *207 - headers: - Link: *43 - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - 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/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator - parameters: - - *455 - - *138 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - example: write - type: string - nullable: true - examples: - default: - summary: Applying write permissions for the new collaborator - value: - permission: write - responses: - '204': - description: Response - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - 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/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator - parameters: - - *455 - - *138 - responses: - '204': - description: Response - '304': *37 - '404': *6 - '403': *29 - '422': *15 - '401': *25 - 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/enterprise-cloud@latest//rest/projects-classic/collaborators#get-project-permission-for-a-user - parameters: - - *455 - - *138 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Project Collaborator Permission - description: Project Collaborator Permission - type: object - properties: - permission: - type: string - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - 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': *37 - '403': *29 - '401': *25 - 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 @@ -60439,8 +59811,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -60969,8 +60341,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: false content: @@ -61259,8 +60631,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -61284,7 +60656,7 @@ paths: documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository '307': *470 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61306,11 +60678,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 - - &485 + - &487 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -61411,7 +60783,7 @@ paths: - expires_at - updated_at examples: - default: &486 + default: &488 value: total_count: 2 artifacts: @@ -61450,7 +60822,7 @@ paths: head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61472,8 +60844,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *456 - - *457 + - *462 + - *463 - &472 name: artifact_id description: The unique identifier of the artifact. @@ -61524,8 +60896,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *456 - - *457 + - *462 + - *463 - *472 responses: '204': @@ -61550,8 +60922,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *456 - - *457 + - *462 + - *463 - *472 - name: archive_format in: path @@ -61566,7 +60938,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': &647 + '410': &649 description: Gone content: application/json: @@ -61576,6 +60948,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/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository + parameters: + - *462 + - *463 + responses: + '200': + description: Response + content: + application/json: + schema: &473 + 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 + example: 14 + examples: + default: *44 + '403': *29 + '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/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository + parameters: + - *462 + - *463 + requestBody: + required: true + content: + application/json: + schema: *473 + examples: + selected_actions: *44 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository + parameters: + - *462 + - *463 + responses: + '200': + description: Response + content: + application/json: + schema: &474 + 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 + example: 10 + examples: + default: *46 + '403': *29 + '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/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository + parameters: + - *462 + - *463 + requestBody: + required: true + content: + application/json: + schema: *474 + examples: + selected_actions: *46 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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 @@ -61593,14 +61115,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *473 + schema: *475 examples: default: value: @@ -61626,11 +61148,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 - - &474 + - &476 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 @@ -61658,13 +61180,13 @@ paths: - last_accessed_at - size_in_bytes default: last_accessed_at - - *106 + - *110 responses: '200': description: Response content: application/json: - schema: &475 + schema: &477 title: Repository actions caches description: Repository actions caches type: object @@ -61706,7 +61228,7 @@ paths: - total_count - actions_caches examples: - default: &476 + default: &478 value: total_count: 1 actions_caches: @@ -61718,7 +61240,7 @@ paths: created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61738,23 +61260,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *456 - - *457 + - *462 + - *463 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *474 + - *476 responses: '200': description: Response content: application/json: - schema: *475 + schema: *477 examples: - default: *476 + default: *478 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61774,8 +61296,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *456 - - *457 + - *462 + - *463 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -61806,9 +61328,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *456 - - *457 - - &477 + - *462 + - *463 + - &479 name: job_id description: The unique identifier of the job. in: path @@ -61820,7 +61342,7 @@ paths: description: Response content: application/json: - schema: &489 + schema: &491 title: Job description: Information of a job execution in a workflow run type: object @@ -62127,9 +61649,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *456 - - *457 - - *477 + - *462 + - *463 + - *479 responses: '302': description: Response @@ -62157,9 +61679,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *456 - - *457 - - *477 + - *462 + - *463 + - *479 requestBody: required: false content: @@ -62180,7 +61702,7 @@ paths: description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -62204,8 +61726,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Status response @@ -62255,8 +61777,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -62290,7 +61812,7 @@ paths: description: Empty response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -62319,8 +61841,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -62338,7 +61860,7 @@ paths: type: integer secrets: type: array - items: &491 + items: &493 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -62358,7 +61880,7 @@ paths: - created_at - updated_at examples: - default: &492 + default: &494 value: total_count: 2 secrets: @@ -62369,7 +61891,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62391,9 +61913,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *456 - - *457 - - *478 + - *462 + - *463 + - *480 - *19 responses: '200': @@ -62410,7 +61932,7 @@ paths: type: integer variables: type: array - items: &495 + items: &497 title: Actions Variable type: object properties: @@ -62440,7 +61962,7 @@ paths: - created_at - updated_at examples: - default: &496 + default: &498 value: total_count: 2 variables: @@ -62453,7 +61975,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62473,8 +61995,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -62483,12 +62005,12 @@ paths: schema: type: object properties: - enabled: &479 + enabled: &481 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *56 - selected_actions_url: *261 - sha_pinning_required: *57 + allowed_actions: *60 + selected_actions_url: *268 + sha_pinning_required: *61 required: - enabled examples: @@ -62518,8 +62040,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -62530,9 +62052,9 @@ paths: schema: type: object properties: - enabled: *479 - allowed_actions: *56 - sha_pinning_required: *57 + enabled: *481 + allowed_actions: *60 + sha_pinning_required: *61 required: - enabled examples: @@ -62563,14 +62085,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: &480 + schema: &482 type: object properties: access_level: @@ -62588,7 +62110,7 @@ paths: required: - access_level examples: - default: &481 + default: &483 value: access_level: organization x-github: @@ -62613,15 +62135,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: application/json: - schema: *480 + schema: *482 examples: - default: *481 + default: *483 responses: '204': description: Response @@ -62645,14 +62167,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *263 + schema: *270 examples: default: value: @@ -62676,8 +62198,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Empty response for successful settings update @@ -62687,7 +62209,7 @@ paths: required: true content: application/json: - schema: *264 + schema: *271 examples: default: summary: Set retention days @@ -62711,16 +62233,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *58 + schema: *62 examples: - default: *265 + default: *272 '404': *6 x-github: enabledForGitHubApps: true @@ -62739,8 +62261,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -62750,7 +62272,7 @@ paths: required: true content: application/json: - schema: *58 + schema: *62 examples: default: summary: Set approval policy to first time contributors @@ -62774,16 +62296,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *266 + schema: *273 examples: - default: *59 + default: *63 '403': *29 '404': *6 x-github: @@ -62803,15 +62325,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: application/json: - schema: *267 + schema: *274 examples: - default: *59 + default: *63 responses: '204': description: Empty response for successful settings update @@ -62835,16 +62357,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *61 + schema: *65 examples: - default: *62 + default: *66 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -62867,8 +62389,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -62876,9 +62398,9 @@ paths: required: false content: application/json: - schema: *61 + schema: *65 examples: - selected_actions: *62 + selected_actions: *66 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -62900,16 +62422,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *270 + schema: *277 examples: - default: *65 + default: *69 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62930,8 +62452,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Success response @@ -62942,9 +62464,9 @@ paths: required: true content: application/json: - schema: *271 + schema: *278 examples: - default: *65 + default: *69 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62971,8 +62493,8 @@ paths: in: query schema: type: string - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -62990,11 +62512,11 @@ paths: type: integer runners: type: array - items: *72 + items: *76 examples: - default: *73 + default: *77 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63016,8 +62538,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -63025,9 +62547,9 @@ paths: application/json: schema: type: array - items: *275 + items: *282 examples: - default: *276 + default: *283 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63049,8 +62571,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -63093,10 +62615,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *277 + '201': *284 '404': *6 '422': *7 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63124,16 +62646,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '201': description: Response content: application/json: - schema: *75 + schema: *79 examples: - default: *278 + default: *285 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63161,16 +62683,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '201': description: Response content: application/json: - schema: *75 + schema: *79 examples: - default: *279 + default: *286 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63192,17 +62714,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *456 - - *457 - - *71 + - *462 + - *463 + - *75 responses: '200': description: Response content: application/json: - schema: *72 + schema: *76 examples: - default: *280 + default: *287 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63223,9 +62745,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *456 - - *457 - - *71 + - *462 + - *463 + - *75 responses: '204': description: Response @@ -63251,11 +62773,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *456 - - *457 - - *71 + - *462 + - *463 + - *75 responses: - '200': *77 + '200': *81 '404': *6 x-github: githubCloudOnly: false @@ -63277,9 +62799,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *456 - - *457 - - *71 + - *462 + - *463 + - *75 requestBody: required: true content: @@ -63303,7 +62825,7 @@ paths: - gpu - accelerated responses: - '200': *77 + '200': *81 '404': *6 '422': *7 x-github: @@ -63327,9 +62849,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *456 - - *457 - - *71 + - *462 + - *463 + - *75 requestBody: required: true content: @@ -63354,7 +62876,7 @@ paths: - gpu - accelerated responses: - '200': *77 + '200': *81 '404': *6 '422': *7 x-github: @@ -63378,11 +62900,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *456 - - *457 - - *71 + - *462 + - *463 + - *75 responses: - '200': *281 + '200': *288 '404': *6 x-github: githubCloudOnly: false @@ -63409,12 +62931,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *456 - - *457 - - *71 - - *282 + - *462 + - *463 + - *75 + - *289 responses: - '200': *77 + '200': *81 '404': *6 '422': *7 x-github: @@ -63440,9 +62962,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *456 - - *457 - - &499 + - *462 + - *463 + - &501 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. @@ -63450,7 +62972,7 @@ paths: required: false schema: type: string - - &500 + - &502 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -63458,7 +62980,7 @@ paths: required: false schema: type: string - - &501 + - &503 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -63467,7 +62989,7 @@ paths: required: false schema: type: string - - &502 + - &504 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 @@ -63494,7 +63016,7 @@ paths: - pending - *17 - *19 - - &503 + - &505 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -63503,7 +63025,7 @@ paths: schema: type: string format: date-time - - &482 + - &484 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -63512,13 +63034,13 @@ paths: schema: type: boolean default: false - - &504 + - &506 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &505 + - &507 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -63541,7 +63063,7 @@ paths: type: integer workflow_runs: type: array - items: &483 + items: &485 title: Workflow Run description: An invocation of a workflow type: object @@ -63636,7 +63158,7 @@ paths: that triggered the run. type: array nullable: true - items: &524 + items: &526 title: Pull Request Minimal type: object properties: @@ -63755,7 +63277,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &528 + properties: &530 id: type: string description: SHA for the commit @@ -63806,7 +63328,7 @@ paths: - name - email nullable: true - required: &529 + required: &531 - id - tree_id - message @@ -63814,8 +63336,8 @@ paths: - author - committer nullable: true - repository: *274 - head_repository: *274 + repository: *281 + head_repository: *281 head_repository_id: type: integer example: 5 @@ -63853,7 +63375,7 @@ paths: - workflow_url - pull_requests examples: - default: &506 + default: &508 value: total_count: 1 workflow_runs: @@ -64067,7 +63589,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: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64089,24 +63611,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *456 - - *457 - - &484 + - *462 + - *463 + - &486 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *482 + - *484 responses: '200': description: Response content: application/json: - schema: *483 + schema: *485 examples: - default: &487 + default: &489 value: id: 30433642 name: Build @@ -64347,9 +63869,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 responses: '204': description: Response @@ -64372,9 +63894,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 responses: '200': description: Response @@ -64493,15 +64015,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 responses: '201': description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -64528,12 +64050,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 - *17 - *19 - - *485 + - *487 responses: '200': description: Response @@ -64551,9 +64073,9 @@ paths: type: array items: *471 examples: - default: *486 + default: *488 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64575,25 +64097,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *456 - - *457 - - *484 - - &488 + - *462 + - *463 + - *486 + - &490 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *482 + - *484 responses: '200': description: Response content: application/json: - schema: *483 + schema: *485 examples: - default: *487 + default: *489 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64616,10 +64138,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *456 - - *457 - - *484 - - *488 + - *462 + - *463 + - *486 + - *490 - *17 - *19 responses: @@ -64637,9 +64159,9 @@ paths: type: integer jobs: type: array - items: *489 + items: *491 examples: - default: &490 + default: &492 value: total_count: 1 jobs: @@ -64728,7 +64250,7 @@ paths: workflow_name: CI head_branch: main headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -64752,10 +64274,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *456 - - *457 - - *484 - - *488 + - *462 + - *463 + - *486 + - *490 responses: '302': description: Response @@ -64783,19 +64305,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 responses: '202': description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64818,9 +64340,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 requestBody: required: true content: @@ -64887,19 +64409,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 responses: '202': description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64922,9 +64444,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 - 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 @@ -64954,11 +64476,11 @@ paths: type: integer jobs: type: array - items: *489 + items: *491 examples: - default: *490 + default: *492 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64981,9 +64503,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 responses: '302': description: Response @@ -65010,9 +64532,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 responses: '204': description: Response @@ -65039,9 +64561,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 responses: '200': description: Response @@ -65101,7 +64623,7 @@ paths: items: type: object properties: - type: &613 + type: &615 type: string description: The type of reviewer. enum: @@ -65111,7 +64633,7 @@ paths: reviewer: anyOf: - *4 - - *303 + - *310 required: - environment - wait_timer @@ -65186,9 +64708,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 requestBody: required: true content: @@ -65235,7 +64757,7 @@ paths: application/json: schema: type: array - items: &599 + items: &601 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -65323,8 +64845,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 required: - id - node_id @@ -65341,7 +64863,7 @@ paths: - created_at - updated_at examples: - default: &600 + default: &602 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -65397,9 +64919,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 requestBody: required: false content: @@ -65420,7 +64942,7 @@ paths: description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -65443,9 +64965,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 requestBody: required: false content: @@ -65466,7 +64988,7 @@ paths: description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -65499,9 +65021,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 responses: '200': description: Response @@ -65638,8 +65160,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -65657,11 +65179,11 @@ paths: type: integer secrets: type: array - items: *491 + items: *493 examples: - default: *492 + default: *494 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65684,16 +65206,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *493 + schema: *495 examples: - default: *494 + default: *496 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65715,17 +65237,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *456 - - *457 - - *284 + - *462 + - *463 + - *291 responses: '200': description: Response content: application/json: - schema: *491 + schema: *493 examples: - default: &626 + default: &628 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -65751,9 +65273,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *456 - - *457 - - *284 + - *462 + - *463 + - *291 requestBody: required: true content: @@ -65784,7 +65306,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -65810,9 +65332,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *456 - - *457 - - *284 + - *462 + - *463 + - *291 responses: '204': description: Response @@ -65837,9 +65359,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *456 - - *457 - - *478 + - *462 + - *463 + - *480 - *19 responses: '200': @@ -65856,11 +65378,11 @@ paths: type: integer variables: type: array - items: *495 + items: *497 examples: - default: *496 + default: *498 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65881,8 +65403,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -65909,7 +65431,7 @@ paths: description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -65934,17 +65456,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *456 - - *457 - - *287 + - *462 + - *463 + - *294 responses: '200': description: Response content: application/json: - schema: *495 + schema: *497 examples: - default: &627 + default: &629 value: name: USERNAME value: octocat @@ -65970,9 +65492,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *456 - - *457 - - *287 + - *462 + - *463 + - *294 requestBody: required: true content: @@ -66014,9 +65536,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *456 - - *457 - - *287 + - *462 + - *463 + - *294 responses: '204': description: Response @@ -66041,8 +65563,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -66060,7 +65582,7 @@ paths: type: integer workflows: type: array - items: &497 + items: &499 title: Workflow description: A GitHub Actions workflow type: object @@ -66144,7 +65666,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: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66167,9 +65689,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *456 - - *457 - - &498 + - *462 + - *463 + - &500 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -66184,7 +65706,7 @@ paths: description: Response content: application/json: - schema: *497 + schema: *499 examples: default: value: @@ -66217,9 +65739,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *456 - - *457 - - *498 + - *462 + - *463 + - *500 responses: '204': description: Response @@ -66244,9 +65766,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *456 - - *457 - - *498 + - *462 + - *463 + - *500 responses: '204': description: Response @@ -66297,9 +65819,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *456 - - *457 - - *498 + - *462 + - *463 + - *500 responses: '204': description: Response @@ -66326,19 +65848,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *456 - - *457 - - *498 - - *499 + - *462 + - *463 - *500 - *501 - *502 - - *17 - - *19 - *503 - - *482 - *504 + - *17 + - *19 - *505 + - *484 + - *506 + - *507 responses: '200': description: Response @@ -66354,11 +65876,11 @@ paths: type: integer workflow_runs: type: array - items: *483 + items: *485 examples: - default: *506 + default: *508 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66389,9 +65911,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *456 - - *457 - - *498 + - *462 + - *463 + - *500 responses: '200': description: Response @@ -66452,12 +65974,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *456 - - *457 - - *106 + - *462 + - *463 + - *110 - *17 - - *104 - - *105 + - *108 + - *109 - name: ref description: |- The Git reference for the activities you want to list. @@ -66598,7 +66120,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 '422': *7 x-github: githubCloudOnly: false @@ -66617,8 +66139,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -66630,9 +66152,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -66655,8 +66177,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *456 - - *457 + - *462 + - *463 - name: assignee in: path required: true @@ -66692,8 +66214,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -66805,11 +66327,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *456 - - *457 + - *462 + - *463 - *17 - - *104 - - *105 + - *108 + - *109 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -66863,7 +66385,7 @@ paths: initiator: type: string examples: - default: *507 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66883,8 +66405,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -66892,7 +66414,7 @@ paths: application/json: schema: type: array - items: &508 + items: &510 title: Autolink reference description: An autolink reference. type: object @@ -66946,8 +66468,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -66986,9 +66508,9 @@ paths: description: response content: application/json: - schema: *508 + schema: *510 examples: - default: &509 + default: &511 value: id: 1 key_prefix: TICKET- @@ -67019,9 +66541,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *456 - - *457 - - &510 + - *462 + - *463 + - &512 name: autolink_id description: The unique identifier of the autolink. in: path @@ -67033,9 +66555,9 @@ paths: description: Response content: application/json: - schema: *508 + schema: *510 examples: - default: *509 + default: *511 '404': *6 x-github: githubCloudOnly: false @@ -67055,9 +66577,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *456 - - *457 - - *510 + - *462 + - *463 + - *512 responses: '204': description: Response @@ -67081,8 +66603,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response if Dependabot is enabled @@ -67130,8 +66652,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -67152,8 +66674,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -67173,8 +66695,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *456 - - *457 + - *462 + - *463 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -67212,7 +66734,7 @@ paths: - url protected: type: boolean - protection: &512 + protection: &514 title: Branch Protection description: Branch Protection type: object @@ -67254,7 +66776,7 @@ paths: required: - contexts - checks - enforce_admins: &515 + enforce_admins: &517 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -67269,7 +66791,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &517 + required_pull_request_reviews: &519 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -67290,7 +66812,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *303 + items: *310 apps: description: The list of apps with review dismissal access. @@ -67319,7 +66841,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *303 + items: *310 apps: description: The list of apps allowed to bypass pull request requirements. @@ -67345,7 +66867,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &514 + restrictions: &516 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -67408,7 +66930,7 @@ paths: type: string teams: type: array - items: *303 + items: *310 apps: type: array items: @@ -67604,7 +67126,7 @@ paths: - linter protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -67622,9 +67144,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *456 - - *457 - - &513 + - *462 + - *463 + - &515 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql). @@ -67638,14 +67160,14 @@ paths: description: Response content: application/json: - schema: &523 + schema: &525 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &573 + commit: &575 title: Commit description: Commit type: object @@ -67679,7 +67201,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &511 + properties: &513 name: type: string example: '"Chris Wanstrath"' @@ -67688,13 +67210,14 @@ paths: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true committer: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *511 + properties: *513 nullable: true message: type: string @@ -67715,7 +67238,7 @@ paths: required: - sha - url - verification: &633 + verification: &635 title: Verification type: object properties: @@ -67749,12 +67272,12 @@ paths: nullable: true oneOf: - *4 - - *285 + - *292 committer: nullable: true oneOf: - *4 - - *285 + - *292 parents: type: array items: @@ -67785,7 +67308,7 @@ paths: type: integer files: type: array - items: &586 + items: &588 title: Diff Entry description: Diff Entry type: object @@ -67869,7 +67392,7 @@ paths: - self protected: type: boolean - protection: *512 + protection: *514 protection_url: type: string format: uri @@ -67998,15 +67521,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *512 + schema: *514 examples: default: value: @@ -68200,9 +67723,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -68457,7 +67980,7 @@ paths: url: type: string format: uri - required_status_checks: &520 + required_status_checks: &522 title: Status Check Policy description: Status Check Policy type: object @@ -68533,7 +68056,7 @@ paths: items: *4 teams: type: array - items: *303 + items: *310 apps: type: array items: *5 @@ -68551,7 +68074,7 @@ paths: items: *4 teams: type: array - items: *303 + items: *310 apps: type: array items: *5 @@ -68609,7 +68132,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *514 + restrictions: *516 required_conversation_resolution: type: object properties: @@ -68721,9 +68244,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -68748,17 +68271,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *515 + schema: *517 examples: - default: &516 + default: &518 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -68780,17 +68303,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *515 + schema: *517 examples: - default: *516 + default: *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68809,9 +68332,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -68836,17 +68359,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *517 + schema: *519 examples: - default: &518 + default: &520 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -68942,9 +68465,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -69042,9 +68565,9 @@ paths: description: Response content: application/json: - schema: *517 + schema: *519 examples: - default: *518 + default: *520 '422': *15 x-github: githubCloudOnly: false @@ -69065,9 +68588,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -69094,17 +68617,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *515 + schema: *517 examples: - default: &519 + default: &521 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -69127,17 +68650,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *515 + schema: *517 examples: - default: *519 + default: *521 '404': *6 x-github: githubCloudOnly: false @@ -69157,9 +68680,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -69184,17 +68707,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *520 + schema: *522 examples: - default: &521 + default: &523 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -69220,9 +68743,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -69274,9 +68797,9 @@ paths: description: Response content: application/json: - schema: *520 + schema: *522 examples: - default: *521 + default: *523 '404': *6 '422': *15 x-github: @@ -69298,9 +68821,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -69324,9 +68847,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response @@ -69360,9 +68883,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -69429,9 +68952,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -69495,9 +69018,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: content: application/json: @@ -69563,15 +69086,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *514 + schema: *516 examples: default: value: @@ -69662,9 +69185,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -69687,9 +69210,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response @@ -69699,7 +69222,7 @@ paths: type: array items: *5 examples: - default: &522 + default: &524 value: - id: 1 slug: octoapp @@ -69756,9 +69279,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -69792,7 +69315,7 @@ paths: type: array items: *5 examples: - default: *522 + default: *524 '422': *15 x-github: githubCloudOnly: false @@ -69813,9 +69336,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -69849,7 +69372,7 @@ paths: type: array items: *5 examples: - default: *522 + default: *524 '422': *15 x-github: githubCloudOnly: false @@ -69870,9 +69393,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -69906,7 +69429,7 @@ paths: type: array items: *5 examples: - default: *522 + default: *524 '422': *15 x-github: githubCloudOnly: false @@ -69928,9 +69451,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response @@ -69938,9 +69461,9 @@ paths: application/json: schema: type: array - items: *303 + items: *310 examples: - default: *375 + default: *382 '404': *6 x-github: githubCloudOnly: false @@ -69960,9 +69483,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -69998,9 +69521,9 @@ paths: application/json: schema: type: array - items: *303 + items: *310 examples: - default: *375 + default: *382 '422': *15 x-github: githubCloudOnly: false @@ -70021,9 +69544,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -70059,9 +69582,9 @@ paths: application/json: schema: type: array - items: *303 + items: *310 examples: - default: *375 + default: *382 '422': *15 x-github: githubCloudOnly: false @@ -70082,9 +69605,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: content: application/json: @@ -70119,9 +69642,9 @@ paths: application/json: schema: type: array - items: *303 + items: *310 examples: - default: *375 + default: *382 '422': *15 x-github: githubCloudOnly: false @@ -70143,9 +69666,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response @@ -70155,7 +69678,7 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 '404': *6 x-github: githubCloudOnly: false @@ -70179,9 +69702,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -70214,7 +69737,7 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 '422': *15 x-github: githubCloudOnly: false @@ -70239,9 +69762,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -70274,7 +69797,7 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 '422': *15 x-github: githubCloudOnly: false @@ -70299,9 +69822,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -70334,7 +69857,7 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 '422': *15 x-github: githubCloudOnly: false @@ -70361,9 +69884,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -70385,7 +69908,7 @@ paths: description: Response content: application/json: - schema: *523 + schema: *525 examples: default: value: @@ -70499,12 +70022,12 @@ paths: category: repos subcategory: bypass-requests parameters: - - *456 - - *457 - - *99 - - *100 - - *101 - - *102 + - *462 + - *463 + - *103 + - *104 + - *105 + - *106 - *17 - *19 responses: @@ -70514,9 +70037,9 @@ paths: application/json: schema: type: array - items: *298 + items: *305 examples: - default: *299 + default: *306 '404': *6 '500': *40 "/repos/{owner}/{repo}/bypass-requests/push-rules/{bypass_request_number}": @@ -70536,8 +70059,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *456 - - *457 + - *462 + - *463 - name: bypass_request_number in: path required: true @@ -70551,7 +70074,7 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: default: value: @@ -70610,12 +70133,12 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *456 - - *457 - - *99 - - *100 - - *101 - - *102 + - *462 + - *463 + - *103 + - *104 + - *105 + - *106 - *17 - *19 responses: @@ -70625,9 +70148,9 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *302 + default: *309 '404': *6 '403': *29 '500': *40 @@ -70651,8 +70174,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *456 - - *457 + - *462 + - *463 - name: bypass_request_number in: path required: true @@ -70664,7 +70187,7 @@ paths: description: A single bypass request. content: application/json: - schema: *301 + schema: *308 examples: default: value: @@ -70722,8 +70245,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *456 - - *457 + - *462 + - *463 - name: bypass_request_number in: path required: true @@ -70794,8 +70317,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *456 - - *457 + - *462 + - *463 - name: bypass_response_id in: path required: true @@ -70828,8 +70351,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -71108,7 +70631,7 @@ paths: description: Response content: application/json: - schema: &525 + schema: &527 title: CheckRun description: A check performed on the code of a given code change type: object @@ -71219,16 +70742,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *524 - deployment: &851 + items: *526 + deployment: &859 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -71295,8 +70818,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 required: - id - node_id @@ -71508,9 +71031,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *456 - - *457 - - &526 + - *462 + - *463 + - &528 name: check_run_id description: The unique identifier of the check run. in: path @@ -71522,9 +71045,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *527 examples: - default: &527 + default: &529 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -71624,9 +71147,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *456 - - *457 - - *526 + - *462 + - *463 + - *528 requestBody: required: true content: @@ -71866,9 +71389,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *527 examples: - default: *527 + default: *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71888,9 +71411,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *456 - - *457 - - *526 + - *462 + - *463 + - *528 - *17 - *19 responses: @@ -71965,7 +71488,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: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71985,15 +71508,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *456 - - *457 - - *526 + - *462 + - *463 + - *528 responses: '201': description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -72031,8 +71554,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -72054,7 +71577,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &530 + schema: &532 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -72118,7 +71641,7 @@ paths: nullable: true pull_requests: type: array - items: *524 + items: *526 nullable: true app: title: GitHub app @@ -72129,9 +71652,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 - repository: *274 + properties: *217 + required: *218 + repository: *281 created_at: type: string format: date-time @@ -72140,12 +71663,12 @@ paths: type: string format: date-time nullable: true - head_commit: &882 + head_commit: &890 title: Simple Commit description: A commit. type: object - properties: *528 - required: *529 + properties: *530 + required: *531 latest_check_runs_count: type: integer check_runs_url: @@ -72173,7 +71696,7 @@ paths: - check_runs_url - pull_requests examples: - default: &531 + default: &533 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -72464,9 +71987,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *530 + schema: *532 examples: - default: *531 + default: *533 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72485,8 +72008,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -72547,7 +72070,7 @@ paths: required: - app_id - setting - repository: *274 + repository: *281 examples: default: value: @@ -72795,9 +72318,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *456 - - *457 - - &532 + - *462 + - *463 + - &534 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -72809,9 +72332,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *532 examples: - default: *531 + default: *533 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72834,17 +72357,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *456 - - *457 - - *532 - - &579 + - *462 + - *463 + - *534 + - &581 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &580 + - &582 name: status description: Returns check runs with the specified `status`. in: query @@ -72883,9 +72406,9 @@ paths: type: integer check_runs: type: array - items: *525 + items: *527 examples: - default: &581 + default: &583 value: total_count: 1 check_runs: @@ -72967,7 +72490,7 @@ paths: url: https://api.github.com/repos/github/hello-world name: hello-world headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72987,15 +72510,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *456 - - *457 - - *532 + - *462 + - *463 + - *534 responses: '201': description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -73022,30 +72545,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *456 - - *457 - - *307 - - *308 + - *462 + - *463 + - *314 + - *315 - *19 - *17 - - &548 + - &550 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: *533 - - &549 + schema: *535 + - &551 name: pr description: The number of the pull request for the results you want to list. in: query required: false schema: type: integer - - *106 - - *104 - - *105 + - *110 + - *108 + - *109 - name: sort description: The property by which to sort the results. in: query @@ -73061,13 +72584,13 @@ paths: be returned. in: query required: false - schema: *309 + schema: *316 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *534 + schema: *536 responses: '200': description: Response @@ -73078,14 +72601,14 @@ paths: items: type: object properties: - number: *123 - created_at: *130 - updated_at: *131 - url: *128 - html_url: *129 - instances_url: *535 - state: *109 - fixed_at: *133 + number: *127 + created_at: *134 + updated_at: *135 + url: *132 + html_url: *133 + instances_url: *537 + state: *113 + fixed_at: *137 dismissed_by: title: Simple User description: A GitHub user. @@ -73093,12 +72616,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *132 - dismissed_reason: *536 - dismissed_comment: *537 - rule: *538 - tool: *539 - most_recent_instance: *540 + dismissed_at: *136 + dismissed_reason: *538 + dismissed_comment: *539 + rule: *540 + tool: *541 + most_recent_instance: *542 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -73224,14 +72747,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &541 + '403': &543 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73251,9 +72774,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *456 - - *457 - - &542 + - *462 + - *463 + - &544 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -73261,23 +72784,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *123 + schema: *127 responses: '200': description: Response content: application/json: - schema: &543 + schema: &545 type: object properties: - number: *123 - created_at: *130 - updated_at: *131 - url: *128 - html_url: *129 - instances_url: *535 - state: *109 - fixed_at: *133 + number: *127 + created_at: *134 + updated_at: *135 + url: *132 + html_url: *133 + instances_url: *537 + state: *113 + fixed_at: *137 dismissed_by: title: Simple User description: A GitHub user. @@ -73285,9 +72808,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *132 - dismissed_reason: *536 - dismissed_comment: *537 + dismissed_at: *136 + dismissed_reason: *538 + dismissed_comment: *539 rule: type: object properties: @@ -73341,8 +72864,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *539 - most_recent_instance: *540 + tool: *541 + most_recent_instance: *542 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -73441,9 +72964,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *541 + '403': *543 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73461,9 +72984,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *456 - - *457 - - *542 + - *462 + - *463 + - *544 requestBody: required: true content: @@ -73478,8 +73001,8 @@ paths: enum: - open - dismissed - dismissed_reason: *536 - dismissed_comment: *537 + dismissed_reason: *538 + dismissed_comment: *539 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -73498,7 +73021,7 @@ paths: description: Response content: application/json: - schema: *543 + schema: *545 examples: default: value: @@ -73574,14 +73097,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &547 + '403': &549 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': *190 + '503': *195 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -73601,15 +73124,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *456 - - *457 - - *542 + - *462 + - *463 + - *544 responses: '200': description: Response content: application/json: - schema: &544 + schema: &546 type: object properties: status: @@ -73635,13 +73158,13 @@ paths: - description - started_at examples: - default: &545 + default: &547 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &546 + '400': &548 description: Bad Request content: application/json: @@ -73652,9 +73175,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': *541 + '403': *543 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73677,29 +73200,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *456 - - *457 - - *542 + - *462 + - *463 + - *544 responses: '200': description: OK content: application/json: - schema: *544 + schema: *546 examples: - default: *545 + default: *547 '202': description: Accepted content: application/json: - schema: *544 + schema: *546 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *546 + '400': *548 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -73709,7 +73232,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73731,9 +73254,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *456 - - *457 - - *542 + - *462 + - *463 + - *544 requestBody: required: false content: @@ -73778,12 +73301,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *546 - '403': *547 + '400': *548 + '403': *549 '404': *6 '422': description: Unprocessable Entity - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73803,13 +73326,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *456 - - *457 - - *542 + - *462 + - *463 + - *544 - *19 - *17 - - *548 - - *549 + - *550 + - *551 responses: '200': description: Response @@ -73817,7 +73340,7 @@ paths: application/json: schema: type: array - items: *540 + items: *542 examples: default: value: @@ -73856,9 +73379,9 @@ paths: end_column: 50 classifications: - source - '403': *541 + '403': *543 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73890,29 +73413,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *456 - - *457 - - *307 - - *308 + - *462 + - *463 + - *314 + - *315 - *19 - *17 - - *549 + - *551 - 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: *533 + schema: *535 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &552 + schema: &554 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 - - *106 + - *110 - name: sort description: The property by which to sort the results. in: query @@ -73929,23 +73452,23 @@ paths: application/json: schema: type: array - items: &553 + items: &555 type: object properties: - ref: *533 - commit_sha: &561 + ref: *535 + commit_sha: &563 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: *550 + analysis_key: *552 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *551 + category: *553 error: type: string example: error reading field xyz @@ -73969,8 +73492,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *552 - tool: *539 + sarif_id: *554 + tool: *541 deletable: type: boolean warning: @@ -74031,9 +73554,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *541 + '403': *543 '404': *6 - '503': *190 + '503': *195 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -74067,8 +73590,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -74081,7 +73604,7 @@ paths: description: Response content: application/json: - schema: *553 + schema: *555 examples: response: summary: application/json response @@ -74135,14 +73658,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *541 + '403': *543 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *190 + '503': *195 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -74222,8 +73745,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -74276,9 +73799,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': *547 + '403': *549 '404': *6 - '503': *190 + '503': *195 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -74298,8 +73821,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -74307,7 +73830,7 @@ paths: application/json: schema: type: array - items: &554 + items: &556 title: CodeQL Database description: A CodeQL database. type: object @@ -74418,9 +73941,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': *541 + '403': *543 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74447,8 +73970,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - name: language in: path description: The language of the CodeQL database. @@ -74460,7 +73983,7 @@ paths: description: Response content: application/json: - schema: *554 + schema: *556 examples: default: value: @@ -74492,11 +74015,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': &588 + '302': &590 description: Found - '403': *541 + '403': *543 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74516,8 +74039,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *456 - - *457 + - *462 + - *463 - name: language in: path description: The language of the CodeQL database. @@ -74527,9 +74050,9 @@ paths: responses: '204': description: Response - '403': *547 + '403': *549 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74555,8 +74078,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -74565,7 +74088,7 @@ paths: type: object additionalProperties: false properties: - language: &555 + language: &557 type: string description: The language targeted by the CodeQL query enum: @@ -74645,7 +74168,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &559 + schema: &561 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -74653,9 +74176,9 @@ paths: id: type: integer description: The ID of the variant analysis. - controller_repo: *115 + controller_repo: *119 actor: *4 - query_language: *555 + query_language: *557 query_pack_url: type: string description: The download url for the query pack. @@ -74702,7 +74225,7 @@ paths: items: type: object properties: - repository: &556 + repository: &558 title: Repository Identifier description: Repository Identifier type: object @@ -74738,7 +74261,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &560 + analysis_status: &562 type: string description: The new status of the CodeQL variant analysis repository task. @@ -74770,7 +74293,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &557 + access_mismatch_repos: &559 type: object properties: repository_count: @@ -74784,7 +74307,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: *556 + items: *558 required: - repository_count - repositories @@ -74806,8 +74329,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *557 - over_limit_repos: *557 + no_codeql_db_repos: *559 + over_limit_repos: *559 required: - access_mismatch_repos - not_found_repos @@ -74823,7 +74346,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &558 + value: &560 summary: Default response value: id: 1 @@ -74975,17 +74498,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *558 + value: *560 repository_lists: summary: Response for a successful variant analysis submission - value: *558 + value: *560 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75006,8 +74529,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *456 - - *457 + - *462 + - *463 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -75019,11 +74542,11 @@ paths: description: Response content: application/json: - schema: *559 + schema: *561 examples: - default: *558 + default: *560 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75044,7 +74567,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *456 + - *462 - name: repo in: path description: The name of the controller repository. @@ -75078,8 +74601,8 @@ paths: schema: type: object properties: - repository: *115 - analysis_status: *560 + repository: *119 + analysis_status: *562 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -75183,7 +74706,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75204,8 +74727,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -75290,9 +74813,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *541 + '403': *543 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75311,8 +74834,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -75379,7 +74902,7 @@ paths: description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -75404,7 +74927,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *547 + '403': *549 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -75418,7 +74941,7 @@ paths: content: application/json: schema: *3 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75475,8 +74998,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -75484,7 +75007,7 @@ paths: schema: type: object properties: - commit_sha: *561 + commit_sha: *563 ref: type: string description: |- @@ -75542,7 +75065,7 @@ paths: schema: type: object properties: - id: *552 + id: *554 url: type: string description: The REST API URL for checking the status of the upload. @@ -75556,11 +75079,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': *547 + '403': *549 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *190 + '503': *195 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -75579,8 +75102,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *456 - - *457 + - *462 + - *463 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -75626,10 +75149,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': *541 + '403': *543 '404': description: Not Found if the sarif id does not match any upload - '503': *190 + '503': *195 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -75651,8 +75174,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -75676,7 +75199,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *110 + configuration: *114 examples: default: value: @@ -75708,7 +75231,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': *150 + '204': *154 '304': *37 '403': *29 '404': *6 @@ -75733,8 +75256,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *456 - - *457 + - *462 + - *463 - 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 @@ -75854,8 +75377,8 @@ paths: parameters: - *17 - *19 - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -75871,7 +75394,7 @@ paths: type: integer codespaces: type: array - items: *365 + items: *372 examples: default: value: @@ -76169,8 +75692,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -76233,22 +75756,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '400': *14 '401': *25 '403': *29 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -76272,8 +75795,8 @@ paths: parameters: - *17 - *19 - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -76337,8 +75860,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -76373,14 +75896,14 @@ paths: type: integer machines: type: array - items: &808 + items: &807 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *563 - required: *564 + properties: *565 + required: *566 examples: - default: &809 + default: &808 value: total_count: 2 machines: @@ -76420,8 +75943,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *456 - - *457 + - *462 + - *463 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -76505,8 +76028,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *456 - - *457 + - *462 + - *463 - 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 @@ -76551,7 +76074,7 @@ paths: '403': *29 '404': *6 '422': *15 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76572,8 +76095,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -76591,7 +76114,7 @@ paths: type: integer secrets: type: array - items: &568 + items: &570 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -76611,9 +76134,9 @@ paths: - created_at - updated_at examples: - default: *565 + default: *567 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76634,16 +76157,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *566 + schema: *568 examples: - default: *567 + default: *569 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -76663,17 +76186,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *456 - - *457 - - *284 + - *462 + - *463 + - *291 responses: '200': description: Response content: application/json: - schema: *568 + schema: *570 examples: - default: *569 + default: *571 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76693,9 +76216,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *456 - - *457 - - *284 + - *462 + - *463 + - *291 requestBody: required: true content: @@ -76723,7 +76246,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -76747,9 +76270,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *456 - - *457 - - *284 + - *462 + - *463 + - *291 responses: '204': description: Response @@ -76777,8 +76300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *456 - - *457 + - *462 + - *463 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -76820,7 +76343,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &570 + properties: &572 login: type: string example: octocat @@ -76913,7 +76436,7 @@ paths: user_view_type: type: string example: public - required: &571 + required: &573 - avatar_url - events_url - followers_url @@ -76962,7 +76485,7 @@ paths: admin: false role_name: write headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -76987,9 +76510,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *456 - - *457 - - *138 + - *462 + - *463 + - *142 responses: '204': description: Response if user is a collaborator @@ -77035,9 +76558,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *456 - - *457 - - *138 + - *462 + - *463 + - *142 requestBody: required: false content: @@ -77063,7 +76586,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &646 + schema: &648 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -77074,7 +76597,7 @@ paths: example: 42 type: integer format: int64 - repository: *274 + repository: *281 invitee: title: Simple User description: A GitHub user. @@ -77252,7 +76775,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *249 + schema: *256 '403': *29 x-github: triggersNotification: true @@ -77292,9 +76815,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *456 - - *457 - - *138 + - *462 + - *463 + - *142 responses: '204': description: No Content when collaborator was removed from the repository. @@ -77325,9 +76848,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *456 - - *457 - - *138 + - *462 + - *463 + - *142 responses: '200': description: if user has admin permissions @@ -77347,8 +76870,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *570 - required: *571 + properties: *572 + required: *573 nullable: true required: - permission @@ -77403,8 +76926,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -77414,7 +76937,7 @@ paths: application/json: schema: type: array - items: &572 + items: &574 title: Commit Comment description: Commit Comment type: object @@ -77455,8 +76978,8 @@ paths: updated_at: type: string format: date-time - author_association: *214 - reactions: *215 + author_association: *219 + reactions: *220 required: - url - html_url @@ -77472,7 +76995,7 @@ paths: - created_at - updated_at examples: - default: &575 + default: &577 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77506,7 +77029,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' author_association: COLLABORATOR headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77531,17 +77054,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 responses: '200': description: Response content: application/json: - schema: *572 + schema: *574 examples: - default: &576 + default: &578 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77598,9 +77121,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 requestBody: required: true content: @@ -77622,7 +77145,7 @@ paths: description: Response content: application/json: - schema: *572 + schema: *574 examples: default: value: @@ -77673,9 +77196,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 responses: '204': description: Response @@ -77696,9 +77219,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. @@ -77724,11 +77247,11 @@ paths: application/json: schema: type: array - items: *445 + items: *453 examples: - default: *447 + default: *455 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -77747,9 +77270,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 requestBody: required: true content: @@ -77781,16 +77304,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '201': description: Reaction created content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -77812,10 +77335,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: + - *462 + - *463 + - *231 - *456 - - *457 - - *226 - - *448 responses: '204': description: Response @@ -77864,8 +77387,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *456 - - *457 + - *462 + - *463 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -77921,9 +77444,9 @@ paths: application/json: schema: type: array - items: *573 + items: *575 examples: - default: &699 + default: &701 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -77993,11 +77516,11 @@ paths: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: - Link: *43 + Link: *47 '500': *40 '400': *14 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78017,9 +77540,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *456 - - *457 - - &574 + - *462 + - *463 + - &576 name: commit_sha description: The SHA of the commit. in: path @@ -78066,7 +77589,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78091,9 +77614,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *456 - - *457 - - *574 + - *462 + - *463 + - *576 - *17 - *19 responses: @@ -78103,11 +77626,11 @@ paths: application/json: schema: type: array - items: *572 + items: *574 examples: - default: *575 + default: *577 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78133,9 +77656,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *456 - - *457 - - *574 + - *462 + - *463 + - *576 requestBody: required: true content: @@ -78170,9 +77693,9 @@ paths: description: Response content: application/json: - schema: *572 + schema: *574 examples: - default: *576 + default: *578 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -78200,9 +77723,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *456 - - *457 - - *574 + - *462 + - *463 + - *576 - *17 - *19 responses: @@ -78212,9 +77735,9 @@ paths: application/json: schema: type: array - items: *577 + items: *579 examples: - default: &691 + default: &693 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -78693,8 +78216,8 @@ paths: auto_merge: draft: false headers: - Link: *43 - '409': *114 + Link: *47 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78751,11 +78274,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *456 - - *457 + - *462 + - *463 - *19 - *17 - - &578 + - &580 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)" @@ -78770,9 +78293,9 @@ paths: description: Response content: application/json: - schema: *573 + schema: *575 examples: - default: &676 + default: &678 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -78859,8 +78382,8 @@ paths: '422': *15 '404': *6 '500': *40 - '503': *190 - '409': *114 + '503': *195 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78885,11 +78408,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *456 - - *457 - - *578 - - *579 + - *462 + - *463 - *580 + - *581 + - *582 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -78923,11 +78446,11 @@ paths: type: integer check_runs: type: array - items: *525 + items: *527 examples: - default: *581 + default: *583 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78950,9 +78473,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *456 - - *457 - - *578 + - *462 + - *463 + - *580 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -78960,7 +78483,7 @@ paths: schema: type: integer example: 1 - - *579 + - *581 - *17 - *19 responses: @@ -78978,7 +78501,7 @@ paths: type: integer check_suites: type: array - items: *530 + items: *532 examples: default: value: @@ -79153,7 +78676,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: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79178,9 +78701,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *456 - - *457 - - *578 + - *462 + - *463 + - *580 - *17 - *19 responses: @@ -79247,7 +78770,7 @@ paths: type: string total_count: type: integer - repository: *274 + repository: *281 commit_url: type: string format: uri @@ -79378,9 +78901,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *456 - - *457 - - *578 + - *462 + - *463 + - *580 - *17 - *19 responses: @@ -79390,7 +78913,7 @@ paths: application/json: schema: type: array - items: &753 + items: &754 title: Status description: The status of a commit. type: object @@ -79470,7 +78993,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 '301': *468 x-github: githubCloudOnly: false @@ -79499,8 +79022,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -79529,20 +79052,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *582 - required: *583 + properties: *584 + required: *585 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &584 + properties: &586 url: type: string format: uri html_url: type: string format: uri - required: &585 + required: &587 - url - html_url nullable: true @@ -79550,32 +79073,32 @@ paths: title: License Simple description: License Simple type: object - properties: *228 - required: *229 + properties: *233 + required: *234 nullable: true contributing: title: Community Health File type: object - properties: *584 - required: *585 + properties: *586 + required: *587 nullable: true readme: title: Community Health File type: object - properties: *584 - required: *585 + properties: *586 + required: *587 nullable: true issue_template: title: Community Health File type: object - properties: *584 - required: *585 + properties: *586 + required: *587 nullable: true pull_request_template: title: Community Health File type: object - properties: *584 - required: *585 + properties: *586 + required: *587 nullable: true required: - code_of_conduct @@ -79702,8 +79225,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *456 - - *457 + - *462 + - *463 - *19 - *17 - name: basehead @@ -79746,8 +79269,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *573 - merge_base_commit: *573 + base_commit: *575 + merge_base_commit: *575 status: type: string enum: @@ -79767,10 +79290,10 @@ paths: example: 6 commits: type: array - items: *573 + items: *575 files: type: array - items: *586 + items: *588 required: - url - html_url @@ -80014,7 +79537,7 @@ paths: module Test" '404': *6 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80056,8 +79579,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *456 - - *457 + - *462 + - *463 - name: path description: path parameter in: path @@ -80200,7 +79723,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &587 + response-if-content-is-a-file: &589 summary: Response if content is a file value: type: file @@ -80332,7 +79855,7 @@ paths: - size - type - url - - &704 + - &706 title: Content File description: Content File type: object @@ -80533,7 +80056,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *587 + response-if-content-is-a-file: *589 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -80602,7 +80125,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *588 + '302': *590 '304': *37 x-github: githubCloudOnly: false @@ -80625,8 +80148,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *456 - - *457 + - *462 + - *463 - name: path description: path parameter in: path @@ -80719,7 +80242,7 @@ paths: description: Response content: application/json: - schema: &589 + schema: &591 title: File Commit description: File Commit type: object @@ -80871,7 +80394,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *591 examples: example-for-creating-a-file: value: @@ -80925,7 +80448,7 @@ paths: schema: oneOf: - *3 - - &628 + - &630 description: Repository rule violation was detected type: object properties: @@ -80946,7 +80469,7 @@ paths: items: type: object properties: - placeholder_id: &745 + placeholder_id: &746 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -80978,8 +80501,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *456 - - *457 + - *462 + - *463 - name: path description: path parameter in: path @@ -81040,7 +80563,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *591 examples: default: value: @@ -81074,8 +80597,8 @@ paths: verified_at: '422': *15 '404': *6 - '409': *114 - '503': *190 + '409': *118 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81095,8 +80618,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *456 - - *457 + - *462 + - *463 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -81196,7 +80719,7 @@ paths: site_admin: false contributions: 32 headers: - Link: *43 + Link: *47 '204': description: Response if repository is empty '403': *29 @@ -81219,23 +80742,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *456 - - *457 - - *323 - - *324 - - *325 - - *326 + - *462 + - *463 + - *330 + - *331 + - *332 + - *333 - 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 - - *327 - - *590 - - *328 - - *329 - - *106 + - *334 + - *592 + - *335 + - *336 + - *110 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -81244,8 +80767,8 @@ paths: schema: type: integer default: 30 - - *104 - - *105 + - *108 + - *109 responses: '200': description: Response @@ -81253,11 +80776,11 @@ paths: application/json: schema: type: array - items: &593 + items: &595 type: object description: A Dependabot alert. properties: - number: *123 + number: *127 state: type: string description: The state of the Dependabot alert. @@ -81272,7 +80795,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: *124 + package: *128 manifest_path: type: string description: The full path to the dependency manifest file, @@ -81299,13 +80822,13 @@ paths: - unknown - direct - transitive - security_advisory: *591 - security_vulnerability: *127 - url: *128 - html_url: *129 - created_at: *130 - updated_at: *131 - dismissed_at: *132 + security_advisory: *593 + security_vulnerability: *131 + url: *132 + html_url: *133 + created_at: *134 + updated_at: *135 + dismissed_at: *136 dismissed_by: title: Simple User description: A GitHub user. @@ -81329,8 +80852,8 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *133 - auto_dismissed_at: *592 + fixed_at: *137 + auto_dismissed_at: *594 required: - number - state @@ -81560,9 +81083,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *456 - - *457 - - &594 + - *462 + - *463 + - &596 name: alert_number in: path description: |- @@ -81571,13 +81094,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *123 + schema: *127 responses: '200': description: Response content: application/json: - schema: *593 + schema: *595 examples: default: value: @@ -81690,9 +81213,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *456 - - *457 - - *594 + - *462 + - *463 + - *596 requestBody: required: true content: @@ -81737,7 +81260,7 @@ paths: description: Response content: application/json: - schema: *593 + schema: *595 examples: default: value: @@ -81843,7 +81366,7 @@ paths: '400': *14 '403': *29 '404': *6 - '409': *114 + '409': *118 '422': *7 x-github: githubCloudOnly: false @@ -81866,8 +81389,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -81885,7 +81408,7 @@ paths: type: integer secrets: type: array - items: &597 + items: &599 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -81916,7 +81439,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81938,16 +81461,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *595 + schema: *597 examples: - default: *596 + default: *598 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81967,15 +81490,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *456 - - *457 - - *284 + - *462 + - *463 + - *291 responses: '200': description: Response content: application/json: - schema: *597 + schema: *599 examples: default: value: @@ -82001,9 +81524,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *456 - - *457 - - *284 + - *462 + - *463 + - *291 requestBody: required: true content: @@ -82031,7 +81554,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -82055,9 +81578,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *456 - - *457 - - *284 + - *462 + - *463 + - *291 responses: '204': description: Response @@ -82079,8 +81602,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *456 - - *457 + - *462 + - *463 - 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 @@ -82216,7 +81739,7 @@ paths: advisory_summary: Ruby OpenID advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 headers: - Link: *43 + Link: *47 '404': *6 '403': description: Response for a private repository when GitHub Advanced Security @@ -82240,8 +81763,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -82457,7 +81980,7 @@ paths: spdxElementId: SPDXRef-DOCUMENT relatedSpdxElement: SPDXRef-Repository headers: - Link: *43 + Link: *47 '404': *6 '403': *29 x-github: @@ -82480,8 +82003,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -82556,7 +82079,7 @@ paths: - version - url additionalProperties: false - metadata: &598 + metadata: &600 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -82589,7 +82112,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *598 + metadata: *600 resolved: type: object description: A collection of resolved package dependencies. @@ -82602,7 +82125,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *598 + metadata: *600 relationship: type: string description: A notation of whether a dependency is requested @@ -82731,8 +82254,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *456 - - *457 + - *462 + - *463 - name: sha description: The SHA recorded at creation time. in: query @@ -82772,11 +82295,11 @@ paths: application/json: schema: type: array - items: *599 + items: *601 examples: - default: *600 + default: *602 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82840,8 +82363,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -82922,7 +82445,7 @@ paths: description: Response content: application/json: - schema: *599 + schema: *601 examples: simple-example: summary: Simple example @@ -82995,9 +82518,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *456 - - *457 - - &601 + - *462 + - *463 + - &603 name: deployment_id description: deployment_id parameter in: path @@ -83009,7 +82532,7 @@ paths: description: Response content: application/json: - schema: *599 + schema: *601 examples: default: value: @@ -83074,9 +82597,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *456 - - *457 - - *601 + - *462 + - *463 + - *603 responses: '204': description: Response @@ -83098,9 +82621,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *456 - - *457 - - *601 + - *462 + - *463 + - *603 - *17 - *19 responses: @@ -83110,7 +82633,7 @@ paths: application/json: schema: type: array - items: &602 + items: &604 title: Deployment Status description: The status of a deployment. type: object @@ -83201,8 +82724,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 required: - id - node_id @@ -83251,7 +82774,7 @@ paths: environment_url: https://test-branch.lab.acme.com log_url: https://example.com/deployment/42/output headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -83271,9 +82794,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *456 - - *457 - - *601 + - *462 + - *463 + - *603 requestBody: required: true content: @@ -83348,9 +82871,9 @@ paths: description: Response content: application/json: - schema: *602 + schema: *604 examples: - default: &603 + default: &605 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -83406,9 +82929,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *456 - - *457 - - *601 + - *462 + - *463 + - *603 - name: status_id in: path required: true @@ -83419,9 +82942,9 @@ paths: description: Response content: application/json: - schema: *602 + schema: *604 examples: - default: *603 + default: *605 '404': *6 x-github: githubCloudOnly: false @@ -83448,12 +82971,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *456 - - *457 - - *604 - - *605 + - *462 + - *463 - *606 - *607 + - *608 + - *609 - *17 - *19 responses: @@ -83463,9 +82986,9 @@ paths: application/json: schema: type: array - items: *608 + items: *610 examples: - default: *609 + default: *611 '404': *6 '403': *29 '500': *40 @@ -83489,8 +83012,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *456 - - *457 + - *462 + - *463 - name: alert_number in: path required: true @@ -83502,7 +83025,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *608 + schema: *610 examples: default: value: @@ -83558,8 +83081,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *456 - - *457 + - *462 + - *463 - name: alert_number in: path required: true @@ -83618,12 +83141,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *456 - - *457 - - *99 - - *100 - - *101 - - *610 + - *462 + - *463 + - *103 + - *104 + - *105 + - *612 - *17 - *19 responses: @@ -83633,9 +83156,9 @@ paths: application/json: schema: type: array - items: *611 + items: *613 examples: - default: *612 + default: *614 '404': *6 '403': *29 '500': *40 @@ -83660,8 +83183,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *456 - - *457 + - *462 + - *463 - name: alert_number in: path required: true @@ -83673,7 +83196,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *611 + schema: *613 examples: default: value: @@ -83731,8 +83254,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *456 - - *457 + - *462 + - *463 - name: alert_number in: path required: true @@ -83801,8 +83324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -83859,8 +83382,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -83877,7 +83400,7 @@ paths: type: integer environments: type: array - items: &614 + items: &616 title: Environment description: Details of a deployment environment type: object @@ -83929,7 +83452,7 @@ paths: type: type: string example: wait_timer - wait_timer: &616 + wait_timer: &618 type: integer example: 30 description: The amount of time to delay a job after @@ -83966,11 +83489,11 @@ paths: items: type: object properties: - type: *613 + type: *615 reviewer: anyOf: - *4 - - *303 + - *310 required: - id - node_id @@ -83990,7 +83513,7 @@ paths: - id - node_id - type - deployment_branch_policy: &617 + deployment_branch_policy: &619 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -84106,9 +83629,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *456 - - *457 - - &615 + - *462 + - *463 + - &617 name: environment_name in: path required: true @@ -84121,9 +83644,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *616 examples: - default: &618 + default: &620 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -84207,9 +83730,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *456 - - *457 - - *615 + - *462 + - *463 + - *617 requestBody: required: false content: @@ -84218,7 +83741,7 @@ paths: type: object nullable: true properties: - wait_timer: *616 + wait_timer: *618 prevent_self_review: type: boolean example: false @@ -84235,13 +83758,13 @@ paths: items: type: object properties: - type: *613 + type: *615 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *617 + deployment_branch_policy: *619 additionalProperties: false examples: default: @@ -84261,9 +83784,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *616 examples: - default: *618 + default: *620 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -84287,9 +83810,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *456 - - *457 - - *615 + - *462 + - *463 + - *617 responses: '204': description: Default response @@ -84314,9 +83837,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *456 - - *457 - - *615 + - *462 + - *463 + - *617 - *17 - *19 responses: @@ -84334,7 +83857,7 @@ paths: example: 2 branch_policies: type: array - items: &619 + items: &621 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -84391,9 +83914,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *456 - - *457 - - *615 + - *462 + - *463 + - *617 requestBody: required: true content: @@ -84439,9 +83962,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *621 examples: - example-wildcard: &620 + example-wildcard: &622 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -84483,10 +84006,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *456 - - *457 - - *615 - - &621 + - *462 + - *463 + - *617 + - &623 name: branch_policy_id in: path required: true @@ -84498,9 +84021,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *621 examples: - default: *620 + default: *622 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84519,10 +84042,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *456 - - *457 - - *615 - - *621 + - *462 + - *463 + - *617 + - *623 requestBody: required: true content: @@ -84550,9 +84073,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *621 examples: - default: *620 + default: *622 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84571,10 +84094,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *456 - - *457 - - *615 - - *621 + - *462 + - *463 + - *617 + - *623 responses: '204': description: Response @@ -84599,9 +84122,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *615 - - *457 - - *456 + - *617 + - *463 + - *462 responses: '200': description: List of deployment protection rules @@ -84617,7 +84140,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &622 + items: &624 title: Deployment protection rule description: Deployment protection rule type: object @@ -84636,7 +84159,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &623 + app: &625 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -84735,9 +84258,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *615 - - *457 - - *456 + - *617 + - *463 + - *462 requestBody: content: application/json: @@ -84758,9 +84281,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *622 + schema: *624 examples: - default: &624 + default: &626 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -84795,9 +84318,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *615 - - *457 - - *456 + - *617 + - *463 + - *462 - *19 - *17 responses: @@ -84816,7 +84339,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *623 + items: *625 examples: default: value: @@ -84851,10 +84374,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *456 - - *457 - - *615 - - &625 + - *462 + - *463 + - *617 + - &627 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -84866,9 +84389,9 @@ paths: description: Response content: application/json: - schema: *622 + schema: *624 examples: - default: *624 + default: *626 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84889,10 +84412,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *615 - - *457 - - *456 - - *625 + - *617 + - *463 + - *462 + - *627 responses: '204': description: Response @@ -84918,9 +84441,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *456 - - *457 - - *615 + - *462 + - *463 + - *617 - *17 - *19 responses: @@ -84938,11 +84461,11 @@ paths: type: integer secrets: type: array - items: *491 + items: *493 examples: - default: *492 + default: *494 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84965,17 +84488,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *456 - - *457 - - *615 + - *462 + - *463 + - *617 responses: '200': description: Response content: application/json: - schema: *493 + schema: *495 examples: - default: *494 + default: *496 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84997,18 +84520,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *456 - - *457 - - *615 - - *284 + - *462 + - *463 + - *617 + - *291 responses: '200': description: Response content: application/json: - schema: *491 + schema: *493 examples: - default: *626 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85030,10 +84553,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *456 - - *457 - - *615 - - *284 + - *462 + - *463 + - *617 + - *291 requestBody: required: true content: @@ -85064,7 +84587,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -85090,10 +84613,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *456 - - *457 - - *615 - - *284 + - *462 + - *463 + - *617 + - *291 responses: '204': description: Default response @@ -85118,10 +84641,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *456 - - *457 - - *615 - - *478 + - *462 + - *463 + - *617 + - *480 - *19 responses: '200': @@ -85138,11 +84661,11 @@ paths: type: integer variables: type: array - items: *495 + items: *497 examples: - default: *496 + default: *498 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85163,9 +84686,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *456 - - *457 - - *615 + - *462 + - *463 + - *617 requestBody: required: true content: @@ -85192,7 +84715,7 @@ paths: description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -85217,18 +84740,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *456 - - *457 - - *615 - - *287 + - *462 + - *463 + - *617 + - *294 responses: '200': description: Response content: application/json: - schema: *495 + schema: *497 examples: - default: *627 + default: *629 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85249,10 +84772,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *456 - - *457 - - *287 - - *615 + - *462 + - *463 + - *294 + - *617 requestBody: required: true content: @@ -85294,10 +84817,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *456 - - *457 - - *287 - - *615 + - *462 + - *463 + - *294 + - *617 responses: '204': description: Response @@ -85319,8 +84842,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -85330,7 +84853,7 @@ paths: application/json: schema: type: array - items: *239 + items: *244 examples: 200-response: value: @@ -85388,8 +84911,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *456 - - *457 + - *462 + - *463 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -85411,7 +84934,7 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: default: value: @@ -85524,7 +85047,7 @@ paths: url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== headers: - Link: *43 + Link: *47 '400': *14 x-github: githubCloudOnly: false @@ -85548,8 +85071,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: false content: @@ -85604,8 +85127,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -85656,7 +85179,7 @@ paths: schema: type: string '404': *6 - '409': *114 + '409': *118 '403': *29 '422': description: Validation failed @@ -85664,8 +85187,8 @@ paths: application/json: schema: oneOf: - - *249 - - *628 + - *256 + - *630 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85690,8 +85213,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *456 - - *457 + - *462 + - *463 - name: file_sha in: path required: true @@ -85742,7 +85265,7 @@ paths: '404': *6 '422': *15 '403': *29 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85790,8 +85313,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -85900,7 +85423,7 @@ paths: description: Response content: application/json: - schema: &629 + schema: &631 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -86064,7 +85587,7 @@ paths: type: string '422': *15 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86114,15 +85637,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *456 - - *457 - - *574 + - *462 + - *463 + - *576 responses: '200': description: Response content: application/json: - schema: *629 + schema: *631 examples: default: value: @@ -86153,7 +85676,7 @@ paths: payload: verified_at: '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86178,9 +85701,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *456 - - *457 - - &630 + - *462 + - *463 + - &632 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. @@ -86197,7 +85720,7 @@ paths: application/json: schema: type: array - items: &631 + items: &633 title: Git Reference description: Git references within a repository type: object @@ -86250,8 +85773,8 @@ paths: sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: - Link: *43 - '409': *114 + Link: *47 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86272,17 +85795,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *456 - - *457 - - *630 + - *462 + - *463 + - *632 responses: '200': description: Response content: application/json: - schema: *631 + schema: *633 examples: - default: &632 + default: &634 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -86292,7 +85815,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86311,8 +85834,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -86341,16 +85864,16 @@ paths: description: Response content: application/json: - schema: *631 + schema: *633 examples: - default: *632 + default: *634 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86369,9 +85892,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *456 - - *457 - - *630 + - *462 + - *463 + - *632 requestBody: required: true content: @@ -86400,11 +85923,11 @@ paths: description: Response content: application/json: - schema: *631 + schema: *633 examples: - default: *632 + default: *634 '422': *15 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86420,16 +85943,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *456 - - *457 - - *630 + - *462 + - *463 + - *632 responses: '204': description: Response '422': description: Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86477,8 +86000,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -86545,7 +86068,7 @@ paths: description: Response content: application/json: - schema: &634 + schema: &636 title: Git Tag description: Metadata for a Git tag type: object @@ -86596,7 +86119,7 @@ paths: - sha - type - url - verification: *633 + verification: *635 required: - sha - url @@ -86606,7 +86129,7 @@ paths: - tag - message examples: - default: &635 + default: &637 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -86633,7 +86156,7 @@ paths: schema: type: string '422': *15 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86679,8 +86202,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *456 - - *457 + - *462 + - *463 - name: tag_sha in: path required: true @@ -86691,11 +86214,11 @@ paths: description: Response content: application/json: - schema: *634 + schema: *636 examples: - default: *635 + default: *637 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86717,8 +86240,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -86791,7 +86314,7 @@ paths: description: Response content: application/json: - schema: &636 + schema: &638 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -86864,7 +86387,7 @@ paths: '422': *15 '404': *6 '403': *29 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86887,8 +86410,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *456 - - *457 + - *462 + - *463 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -86911,7 +86434,7 @@ paths: description: Response content: application/json: - schema: *636 + schema: *638 examples: default-response: summary: Default response @@ -86952,7 +86475,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86970,8 +86493,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -86981,7 +86504,7 @@ paths: application/json: schema: type: array - items: &637 + items: &639 title: Webhook description: Webhooks for repositories. type: object @@ -87035,7 +86558,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &890 + last_response: &898 title: Hook Response type: object properties: @@ -87090,7 +86613,7 @@ paths: status: unused message: headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -87109,8 +86632,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: false content: @@ -87162,9 +86685,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *639 examples: - default: &638 + default: &640 value: type: Repository id: 12345678 @@ -87212,17 +86735,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 responses: '200': description: Response content: application/json: - schema: *637 + schema: *639 examples: - default: *638 + default: *640 '404': *6 x-github: githubCloudOnly: false @@ -87242,9 +86765,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 requestBody: required: true content: @@ -87289,9 +86812,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *639 examples: - default: *638 + default: *640 '422': *15 '404': *6 x-github: @@ -87312,9 +86835,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 responses: '204': description: Response @@ -87338,9 +86861,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 responses: '200': description: Response @@ -87367,9 +86890,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 requestBody: required: false content: @@ -87413,11 +86936,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 - *17 - - *338 + - *345 responses: '200': description: Response @@ -87425,9 +86948,9 @@ paths: application/json: schema: type: array - items: *339 + items: *346 examples: - default: *340 + default: *347 '400': *14 '422': *15 x-github: @@ -87446,18 +86969,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 - *16 responses: '200': description: Response content: application/json: - schema: *341 + schema: *348 examples: - default: *342 + default: *349 '400': *14 '422': *15 x-github: @@ -87476,9 +86999,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 - *16 responses: '202': *39 @@ -87501,9 +87024,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 responses: '204': description: Response @@ -87528,9 +87051,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 responses: '204': description: Response @@ -87553,8 +87076,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response if immutable releases are enabled @@ -87600,11 +87123,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *456 - - *457 + - *462 + - *463 responses: - '204': *150 - '409': *114 + '204': *154 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87621,11 +87144,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *456 - - *457 + - *462 + - *463 responses: - '204': *150 - '409': *114 + '204': *154 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87679,14 +87202,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: &639 + schema: &641 title: Import description: A repository import from an external source. type: object @@ -87785,7 +87308,7 @@ paths: - html_url - authors_url examples: - default: &642 + default: &644 value: vcs: subversion use_lfs: true @@ -87801,7 +87324,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': &640 + '503': &642 description: Unavailable due to service under maintenance. content: application/json: @@ -87830,8 +87353,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -87879,7 +87402,7 @@ paths: description: Response content: application/json: - schema: *639 + schema: *641 examples: default: value: @@ -87904,7 +87427,7 @@ paths: type: string '422': *15 '404': *6 - '503': *640 + '503': *642 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87932,8 +87455,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: false content: @@ -87982,7 +87505,7 @@ paths: description: Response content: application/json: - schema: *639 + schema: *641 examples: example-1: summary: Example 1 @@ -88030,7 +87553,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': *640 + '503': *642 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88053,12 +87576,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response - '503': *640 + '503': *642 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88084,9 +87607,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *456 - - *457 - - &830 + - *462 + - *463 + - &829 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -88100,7 +87623,7 @@ paths: application/json: schema: type: array - items: &641 + items: &643 title: Porter Author description: Porter Author type: object @@ -88154,7 +87677,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': *640 + '503': *642 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88179,8 +87702,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *456 - - *457 + - *462 + - *463 - name: author_id in: path required: true @@ -88210,7 +87733,7 @@ paths: description: Response content: application/json: - schema: *641 + schema: *643 examples: default: value: @@ -88223,7 +87746,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *640 + '503': *642 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88247,8 +87770,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -88289,7 +87812,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *640 + '503': *642 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88317,8 +87840,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -88345,11 +87868,11 @@ paths: description: Response content: application/json: - schema: *639 + schema: *641 examples: - default: *642 + default: *644 '422': *15 - '503': *640 + '503': *642 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88372,8 +87895,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -88381,7 +87904,7 @@ paths: application/json: schema: *22 examples: - default: *643 + default: *645 '301': *468 '404': *6 x-github: @@ -88402,8 +87925,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -88411,12 +87934,12 @@ paths: application/json: schema: anyOf: - - *355 + - *362 - type: object properties: {} additionalProperties: false examples: - default: &645 + default: &647 value: limit: collaborators_only origin: repository @@ -88441,13 +87964,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: application/json: - schema: *644 + schema: *646 examples: default: summary: Example request body @@ -88459,9 +87982,9 @@ paths: description: Response content: application/json: - schema: *355 + schema: *362 examples: - default: *645 + default: *647 '409': description: Response x-github: @@ -88483,8 +88006,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -88507,8 +88030,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -88518,9 +88041,9 @@ paths: application/json: schema: type: array - items: *646 + items: *648 examples: - default: &823 + default: &822 value: - id: 1 repository: @@ -88634,7 +88157,7 @@ paths: html_url: https://github.com/octocat/Hello-World/invitations node_id: MDQ6VXNlcjE= headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88651,9 +88174,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *456 - - *457 - - *359 + - *462 + - *463 + - *366 requestBody: required: false content: @@ -88682,7 +88205,7 @@ paths: description: Response content: application/json: - schema: *646 + schema: *648 examples: default: value: @@ -88813,9 +88336,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *456 - - *457 - - *359 + - *462 + - *463 + - *366 responses: '204': description: Response @@ -88846,8 +88369,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *456 - - *457 + - *462 + - *463 - 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 @@ -88895,7 +88418,7 @@ paths: required: false schema: type: string - - *363 + - *370 - name: sort description: What to sort results by. in: query @@ -88907,8 +88430,8 @@ paths: - updated - comments default: created - - *106 - - *217 + - *110 + - *222 - *17 - *19 responses: @@ -88918,9 +88441,9 @@ paths: application/json: schema: type: array - items: *227 + items: *232 examples: - default: &656 + default: &658 value: - id: 1 node_id: MDU6SXNzdWUx @@ -89067,7 +88590,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *43 + Link: *47 '301': *468 '422': *15 '404': *6 @@ -89097,8 +88620,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -89180,9 +88703,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: &653 + default: &655 value: id: 1 node_id: MDU6SXNzdWUx @@ -89336,9 +88859,9 @@ paths: '400': *14 '403': *29 '422': *15 - '503': *190 + '503': *195 '404': *6 - '410': *647 + '410': *649 x-github: triggersNotification: true githubCloudOnly: false @@ -89366,9 +88889,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *456 - - *457 - - *237 + - *462 + - *463 + - *242 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -89378,7 +88901,7 @@ paths: enum: - asc - desc - - *217 + - *222 - *17 - *19 responses: @@ -89388,9 +88911,9 @@ paths: application/json: schema: type: array - items: *648 + items: *650 examples: - default: &655 + default: &657 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -89421,7 +88944,7 @@ paths: issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR headers: - Link: *43 + Link: *47 '422': *15 '404': *6 x-github: @@ -89448,17 +88971,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 responses: '200': description: Response content: application/json: - schema: *648 + schema: *650 examples: - default: &649 + default: &651 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -89512,9 +89035,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 requestBody: required: true content: @@ -89536,9 +89059,9 @@ paths: description: Response content: application/json: - schema: *648 + schema: *650 examples: - default: *649 + default: *651 '422': *15 x-github: githubCloudOnly: false @@ -89556,9 +89079,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 responses: '204': description: Response @@ -89578,9 +89101,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. @@ -89606,11 +89129,11 @@ paths: application/json: schema: type: array - items: *445 + items: *453 examples: - default: *447 + default: *455 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -89629,9 +89152,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 requestBody: required: true content: @@ -89663,16 +89186,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '201': description: Reaction created content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -89694,10 +89217,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: + - *462 + - *463 + - *231 - *456 - - *457 - - *226 - - *448 responses: '204': description: Response @@ -89717,8 +89240,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -89728,7 +89251,7 @@ paths: application/json: schema: type: array - items: &652 + items: &654 title: Issue Event description: Issue Event type: object @@ -89771,8 +89294,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *650 - required: *651 + properties: *652 + required: *653 nullable: true label: title: Issue Event Label @@ -89816,7 +89339,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *303 + requested_team: *310 dismissed_review: title: Issue Event Dismissed Review type: object @@ -89881,7 +89404,7 @@ paths: required: - from - to - author_association: *214 + author_association: *219 lock_reason: type: string nullable: true @@ -89894,8 +89417,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 required: - id - node_id @@ -90061,7 +89584,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *43 + Link: *47 '422': *15 x-github: githubCloudOnly: false @@ -90079,8 +89602,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *456 - - *457 + - *462 + - *463 - name: event_id in: path required: true @@ -90091,7 +89614,7 @@ paths: description: Response content: application/json: - schema: *652 + schema: *654 examples: default: value: @@ -90284,7 +89807,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *647 + '410': *649 '403': *29 x-github: githubCloudOnly: false @@ -90318,9 +89841,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *456 - - *457 - - &654 + - *462 + - *463 + - &656 name: issue_number description: The number that identifies the issue. in: path @@ -90332,12 +89855,12 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 '301': *468 '404': *6 - '410': *647 + '410': *649 '304': *37 x-github: githubCloudOnly: false @@ -90362,9 +89885,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: false content: @@ -90468,15 +89991,15 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 '422': *15 - '503': *190 + '503': *195 '403': *29 '301': *468 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90494,9 +90017,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: false content: @@ -90522,9 +90045,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90540,9 +90063,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: content: application/json: @@ -90567,9 +90090,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90591,9 +90114,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - name: assignee in: path required: true @@ -90633,10 +90156,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *456 - - *457 - - *654 - - *217 + - *462 + - *463 + - *656 + - *222 - *17 - *19 responses: @@ -90646,13 +90169,13 @@ paths: application/json: schema: type: array - items: *648 + items: *650 examples: - default: *655 + default: *657 headers: - Link: *43 + Link: *47 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90681,9 +90204,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: true content: @@ -90705,16 +90228,16 @@ paths: description: Response content: application/json: - schema: *648 + schema: *650 examples: - default: *649 + default: *651 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *647 + '410': *649 '422': *15 '404': *6 x-github: @@ -90742,9 +90265,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - *17 - *19 responses: @@ -90754,14 +90277,14 @@ paths: application/json: schema: type: array - items: *227 + items: *232 examples: - default: *656 + default: *658 headers: - Link: *43 + Link: *47 '301': *468 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90789,9 +90312,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: true content: @@ -90813,9 +90336,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by @@ -90823,7 +90346,7 @@ paths: type: string '301': *468 '403': *29 - '410': *647 + '410': *649 '422': *15 '404': *6 x-github: @@ -90854,9 +90377,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -90868,15 +90391,15 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 '301': *468 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *647 + '410': *649 x-github: triggersNotification: true githubCloudOnly: false @@ -90902,9 +90425,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - *17 - *19 responses: @@ -90914,14 +90437,14 @@ paths: application/json: schema: type: array - items: *227 + items: *232 examples: - default: *656 + default: *658 headers: - Link: *43 + Link: *47 '301': *468 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90938,9 +90461,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - *17 - *19 responses: @@ -90954,7 +90477,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &659 + - &661 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -90985,8 +90508,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 label: type: object properties: @@ -91008,7 +90531,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &660 + - &662 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -91039,8 +90562,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 label: type: object properties: @@ -91128,8 +90651,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 assignee: *4 assigner: *4 required: @@ -91144,7 +90667,7 @@ paths: - performed_via_github_app - assignee - assigner - - &661 + - &663 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -91175,8 +90698,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 milestone: type: object properties: @@ -91195,7 +90718,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &662 + - &664 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -91226,8 +90749,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 milestone: type: object properties: @@ -91246,7 +90769,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &663 + - &665 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -91277,8 +90800,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 rename: type: object properties: @@ -91300,7 +90823,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &664 + - &666 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -91331,10 +90854,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 review_requester: *4 - requested_team: *303 + requested_team: *310 requested_reviewer: *4 required: - review_requester @@ -91347,7 +90870,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &665 + - &667 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -91378,10 +90901,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 review_requester: *4 - requested_team: *303 + requested_team: *310 requested_reviewer: *4 required: - review_requester @@ -91394,7 +90917,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &666 + - &668 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -91425,8 +90948,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 dismissed_review: type: object properties: @@ -91454,7 +90977,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &667 + - &669 title: Locked Issue Event description: Locked Issue Event type: object @@ -91485,8 +91008,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 lock_reason: type: string example: '"off-topic"' @@ -91502,7 +91025,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &668 + - &670 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -91533,8 +91056,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 project_card: type: object properties: @@ -91568,7 +91091,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &669 + - &671 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -91599,8 +91122,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 project_card: type: object properties: @@ -91634,7 +91157,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &670 + - &672 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -91665,8 +91188,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 project_card: type: object properties: @@ -91700,7 +91223,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &671 + - &673 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -91790,8 +91313,8 @@ paths: name: label color: red headers: - Link: *43 - '410': *647 + Link: *47 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91808,9 +91331,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - *17 - *19 responses: @@ -91820,7 +91343,7 @@ paths: application/json: schema: type: array - items: &657 + items: &659 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -91867,7 +91390,7 @@ paths: - color - default examples: - default: &658 + default: &660 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -91884,10 +91407,10 @@ paths: color: a2eeef default: false headers: - Link: *43 + Link: *47 '301': *468 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91904,9 +91427,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: false content: @@ -91965,12 +91488,12 @@ paths: application/json: schema: type: array - items: *657 + items: *659 examples: - default: *658 + default: *660 '301': *468 '404': *6 - '410': *647 + '410': *649 '422': *15 x-github: githubCloudOnly: false @@ -91987,9 +91510,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: false content: @@ -92049,12 +91572,12 @@ paths: application/json: schema: type: array - items: *657 + items: *659 examples: - default: *658 + default: *660 '301': *468 '404': *6 - '410': *647 + '410': *649 '422': *15 x-github: githubCloudOnly: false @@ -92071,15 +91594,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 responses: '204': description: Response '301': *468 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92098,9 +91621,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - name: name in: path required: true @@ -92113,7 +91636,7 @@ paths: application/json: schema: type: array - items: *657 + items: *659 examples: default: value: @@ -92126,7 +91649,7 @@ paths: default: true '301': *468 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92146,9 +91669,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: false content: @@ -92176,7 +91699,7 @@ paths: '204': description: Response '403': *29 - '410': *647 + '410': *649 '404': *6 '422': *15 x-github: @@ -92194,9 +91717,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 responses: '204': description: Response @@ -92226,20 +91749,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 responses: '200': description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 '301': *468 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92256,9 +91779,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -92284,13 +91807,13 @@ paths: application/json: schema: type: array - items: *445 + items: *453 examples: - default: *447 + default: *455 headers: - Link: *43 + Link: *47 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92308,9 +91831,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: true content: @@ -92342,16 +91865,16 @@ paths: description: Response content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '201': description: Response content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -92373,10 +91896,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: + - *462 + - *463 + - *656 - *456 - - *457 - - *654 - - *448 responses: '204': description: Response @@ -92405,9 +91928,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: true content: @@ -92429,9 +91952,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -92464,9 +91987,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - *17 - *19 responses: @@ -92476,13 +91999,13 @@ paths: application/json: schema: type: array - items: *227 + items: *232 examples: - default: *656 + default: *658 headers: - Link: *43 + Link: *47 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92510,9 +92033,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: true content: @@ -92539,16 +92062,16 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *647 + '410': *649 '422': *15 '404': *6 x-github: @@ -92568,9 +92091,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: true content: @@ -92601,13 +92124,13 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 '403': *29 '404': *6 '422': *7 - '503': *190 + '503': *195 x-github: triggersNotification: true githubCloudOnly: false @@ -92625,9 +92148,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - *17 - *19 responses: @@ -92642,8 +92165,6 @@ paths: description: Timeline Event type: object anyOf: - - *659 - - *660 - *661 - *662 - *663 @@ -92655,6 +92176,8 @@ paths: - *669 - *670 - *671 + - *672 + - *673 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -92697,7 +92220,7 @@ paths: issue_url: type: string format: uri - author_association: *214 + author_association: *219 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -92707,9 +92230,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 - reactions: *215 + properties: *217 + required: *218 + reactions: *220 required: - event - actor @@ -92740,7 +92263,7 @@ paths: properties: type: type: string - issue: *227 + issue: *232 required: - event - created_at @@ -92940,7 +92463,7 @@ paths: type: string body_text: type: string - author_association: *214 + author_association: *219 required: - event - id @@ -92963,7 +92486,7 @@ paths: type: string comments: type: array - items: &693 + items: &695 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -93052,7 +92575,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *214 + author_association: *219 _links: type: object properties: @@ -93136,7 +92659,7 @@ paths: enum: - line - file - reactions: *215 + reactions: *220 body_html: type: string example: '"

comment body

"' @@ -93172,7 +92695,7 @@ paths: type: string comments: type: array - items: *572 + items: *574 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -93203,8 +92726,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 assignee: *4 required: - id @@ -93247,8 +92770,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 assignee: *4 required: - id @@ -93291,8 +92814,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 state_reason: type: string nullable: true @@ -93459,9 +92982,9 @@ paths: type: User site_admin: true headers: - Link: *43 + Link: *47 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93478,8 +93001,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -93489,7 +93012,7 @@ paths: application/json: schema: type: array - items: &672 + items: &674 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -93539,7 +93062,7 @@ paths: last_used: '2022-01-10T15:53:42Z' enabled: true headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93555,8 +93078,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -93592,9 +93115,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *674 examples: - default: &673 + default: &675 value: id: 1 key: ssh-rsa AAA... @@ -93628,9 +93151,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *456 - - *457 - - &674 + - *462 + - *463 + - &676 name: key_id description: The unique identifier of the key. in: path @@ -93642,9 +93165,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *674 examples: - default: *673 + default: *675 '404': *6 x-github: githubCloudOnly: false @@ -93662,9 +93185,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *456 - - *457 - - *674 + - *462 + - *463 + - *676 responses: '204': description: Response @@ -93684,8 +93207,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -93695,11 +93218,11 @@ paths: application/json: schema: type: array - items: *657 + items: *659 examples: - default: *658 + default: *660 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -93718,8 +93241,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -93755,9 +93278,9 @@ paths: description: Response content: application/json: - schema: *657 + schema: *659 examples: - default: &675 + default: &677 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -93789,8 +93312,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *456 - - *457 + - *462 + - *463 - name: name in: path required: true @@ -93801,9 +93324,9 @@ paths: description: Response content: application/json: - schema: *657 + schema: *659 examples: - default: *675 + default: *677 '404': *6 x-github: githubCloudOnly: false @@ -93820,8 +93343,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *456 - - *457 + - *462 + - *463 - name: name in: path required: true @@ -93860,7 +93383,7 @@ paths: description: Response content: application/json: - schema: *657 + schema: *659 examples: default: value: @@ -93886,8 +93409,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *456 - - *457 + - *462 + - *463 - name: name in: path required: true @@ -93913,8 +93436,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -93950,8 +93473,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '202': *39 '403': @@ -93979,8 +93502,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -94006,9 +93529,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *456 - - *457 - - *548 + - *462 + - *463 + - *550 responses: '200': description: Response @@ -94070,8 +93593,8 @@ paths: title: License Simple description: License Simple type: object - properties: *228 - required: *229 + properties: *233 + required: *234 nullable: true required: - _links @@ -94153,8 +93676,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -94219,8 +93742,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -94254,9 +93777,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *573 + schema: *575 examples: - default: *676 + default: *678 '204': description: Response when already merged '404': @@ -94281,8 +93804,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *456 - - *457 + - *462 + - *463 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -94323,12 +93846,12 @@ paths: application/json: schema: type: array - items: &677 + items: &679 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *395 - required: *396 + properties: *402 + required: *403 examples: default: value: @@ -94367,7 +93890,7 @@ paths: closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -94384,8 +93907,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -94425,9 +93948,9 @@ paths: description: Response content: application/json: - schema: *677 + schema: *679 examples: - default: &678 + default: &680 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -94486,9 +94009,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *456 - - *457 - - &679 + - *462 + - *463 + - &681 name: milestone_number description: The number that identifies the milestone. in: path @@ -94500,9 +94023,9 @@ paths: description: Response content: application/json: - schema: *677 + schema: *679 examples: - default: *678 + default: *680 '404': *6 x-github: githubCloudOnly: false @@ -94519,9 +94042,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *456 - - *457 - - *679 + - *462 + - *463 + - *681 requestBody: required: false content: @@ -94559,9 +94082,9 @@ paths: description: Response content: application/json: - schema: *677 + schema: *679 examples: - default: *678 + default: *680 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94577,9 +94100,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *456 - - *457 - - *679 + - *462 + - *463 + - *681 responses: '204': description: Response @@ -94600,9 +94123,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *456 - - *457 - - *679 + - *462 + - *463 + - *681 - *17 - *19 responses: @@ -94612,11 +94135,11 @@ paths: application/json: schema: type: array - items: *657 + items: *659 examples: - default: *658 + default: *660 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94633,12 +94156,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *456 - - *457 - - *680 - - *681 - - *217 + - *462 + - *463 - *682 + - *683 + - *222 + - *684 - *17 - *19 responses: @@ -94648,11 +94171,11 @@ paths: application/json: schema: type: array - items: *240 + items: *245 examples: - default: *683 + default: *685 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -94674,8 +94197,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: false content: @@ -94733,14 +94256,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: &684 + schema: &686 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -94865,7 +94388,7 @@ paths: - custom_404 - public examples: - default: &685 + default: &687 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -94906,8 +94429,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -94961,11 +94484,11 @@ paths: description: Response content: application/json: - schema: *684 + schema: *686 examples: - default: *685 + default: *687 '422': *15 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94986,8 +94509,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -95073,7 +94596,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95094,14 +94617,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response '422': *15 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95121,8 +94644,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -95132,7 +94655,7 @@ paths: application/json: schema: type: array - items: &686 + items: &688 title: Page Build description: Page Build type: object @@ -95207,7 +94730,7 @@ paths: created_at: '2014-02-10T19:00:49Z' updated_at: '2014-02-10T19:00:51Z' headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95226,8 +94749,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *456 - - *457 + - *462 + - *463 responses: '201': description: Response @@ -95272,16 +94795,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *686 + schema: *688 examples: - default: &687 + default: &689 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -95329,8 +94852,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *456 - - *457 + - *462 + - *463 - name: build_id in: path required: true @@ -95341,9 +94864,9 @@ paths: description: Response content: application/json: - schema: *686 + schema: *688 examples: - default: *687 + default: *689 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95363,8 +94886,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -95469,9 +94992,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *456 - - *457 - - &688 + - *462 + - *463 + - &690 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -95529,11 +95052,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *456 - - *457 - - *688 + - *462 + - *463 + - *690 responses: - '204': *150 + '204': *154 '404': *6 x-github: githubCloudOnly: false @@ -95558,8 +95081,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -95790,7 +95313,7 @@ paths: description: Empty response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -95817,8 +95340,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Private vulnerability reporting status @@ -95855,10 +95378,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: - '204': *150 + '204': *154 '422': *14 x-github: githubCloudOnly: false @@ -95877,10 +95400,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: - '204': *150 + '204': *154 '422': *14 x-github: githubCloudOnly: false @@ -95900,8 +95423,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -95909,9 +95432,9 @@ paths: application/json: schema: type: array - items: *151 + items: *155 examples: - default: *689 + default: *691 '403': *29 '404': *6 x-github: @@ -95933,8 +95456,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -95946,11 +95469,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *151 + items: *155 required: - properties examples: - default: *690 + default: *692 responses: '204': description: No Content when custom property values are successfully created @@ -95988,8 +95511,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *456 - - *457 + - *462 + - *463 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -96049,11 +95572,11 @@ paths: application/json: schema: type: array - items: *577 + items: *579 examples: - default: *691 + default: *693 headers: - Link: *43 + Link: *47 '304': *37 '422': *15 x-github: @@ -96083,8 +95606,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -96149,7 +95672,7 @@ paths: description: Response content: application/json: - schema: &695 + schema: &697 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -96260,8 +95783,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *395 - required: *396 + properties: *402 + required: *403 nullable: true active_lock_reason: type: string @@ -96306,7 +95829,7 @@ paths: nullable: true requested_teams: type: array - items: *429 + items: *437 nullable: true head: type: object @@ -96315,7 +95838,7 @@ paths: type: string ref: type: string - repo: *74 + repo: *78 sha: type: string user: *4 @@ -96332,7 +95855,7 @@ paths: type: string ref: type: string - repo: *74 + repo: *78 sha: type: string user: *4 @@ -96345,14 +95868,14 @@ paths: _links: type: object properties: - comments: *397 - commits: *397 - statuses: *397 - html: *397 - issue: *397 - review_comments: *397 - review_comment: *397 - self: *397 + comments: *404 + commits: *404 + statuses: *404 + html: *404 + issue: *404 + review_comments: *404 + review_comment: *404 + self: *404 required: - comments - commits @@ -96362,8 +95885,8 @@ paths: - review_comments - review_comment - self - author_association: *214 - auto_merge: *692 + author_association: *219 + auto_merge: *694 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -96455,7 +95978,7 @@ paths: - merged_by - review_comments examples: - default: &696 + default: &698 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -96982,8 +96505,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - name: sort in: query required: false @@ -97002,7 +96525,7 @@ paths: enum: - asc - desc - - *217 + - *222 - *17 - *19 responses: @@ -97012,9 +96535,9 @@ paths: application/json: schema: type: array - items: *693 + items: *695 examples: - default: &698 + default: &700 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97066,7 +96589,7 @@ paths: original_line: 2 side: RIGHT headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97091,17 +96614,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 responses: '200': description: Response content: application/json: - schema: *693 + schema: *695 examples: - default: &694 + default: &696 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97176,9 +96699,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 requestBody: required: true content: @@ -97200,9 +96723,9 @@ paths: description: Response content: application/json: - schema: *693 + schema: *695 examples: - default: *694 + default: *696 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97218,9 +96741,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 responses: '204': description: Response @@ -97241,9 +96764,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. @@ -97269,11 +96792,11 @@ paths: application/json: schema: type: array - items: *445 + items: *453 examples: - default: *447 + default: *455 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -97292,9 +96815,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 requestBody: required: true content: @@ -97326,16 +96849,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '201': description: Reaction created content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -97357,10 +96880,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: + - *462 + - *463 + - *231 - *456 - - *457 - - *226 - - *448 responses: '204': description: Response @@ -97403,9 +96926,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *456 - - *457 - - &697 + - *462 + - *463 + - &699 name: pull_number description: The number that identifies the pull request. in: path @@ -97418,9 +96941,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *695 + schema: *697 examples: - default: *696 + default: *698 '304': *37 '404': *6 '406': @@ -97429,7 +96952,7 @@ paths: application/json: schema: *3 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97455,9 +96978,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 requestBody: required: false content: @@ -97499,9 +97022,9 @@ paths: description: Response content: application/json: - schema: *695 + schema: *697 examples: - default: *696 + default: *698 '422': *15 '403': *29 x-github: @@ -97523,9 +97046,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 requestBody: required: true content: @@ -97585,21 +97108,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '401': *25 '403': *29 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97625,10 +97148,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *456 - - *457 - - *697 - - *237 + - *462 + - *463 + - *699 + - *242 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -97638,7 +97161,7 @@ paths: enum: - asc - desc - - *217 + - *222 - *17 - *19 responses: @@ -97648,11 +97171,11 @@ paths: application/json: schema: type: array - items: *693 + items: *695 examples: - default: *698 + default: *700 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97683,9 +97206,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 requestBody: required: true content: @@ -97790,7 +97313,7 @@ paths: description: Response content: application/json: - schema: *693 + schema: *695 examples: example-for-a-multi-line-comment: value: @@ -97878,10 +97401,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *456 - - *457 - - *697 - - *226 + - *462 + - *463 + - *699 + - *231 requestBody: required: true content: @@ -97903,7 +97426,7 @@ paths: description: Response content: application/json: - schema: *693 + schema: *695 examples: default: value: @@ -97989,9 +97512,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 - *17 - *19 responses: @@ -98001,11 +97524,11 @@ paths: application/json: schema: type: array - items: *573 + items: *575 examples: - default: *699 + default: *701 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98033,9 +97556,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 - *17 - *19 responses: @@ -98045,7 +97568,7 @@ paths: application/json: schema: type: array - items: *586 + items: *588 examples: default: value: @@ -98061,10 +97584,10 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" headers: - Link: *43 + Link: *47 '422': *15 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98083,9 +97606,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 responses: '204': description: Response if pull request has been merged @@ -98108,9 +97631,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 requestBody: required: false content: @@ -98221,9 +97744,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 responses: '200': description: Response @@ -98239,7 +97762,7 @@ paths: items: *4 teams: type: array - items: *303 + items: *310 required: - users - teams @@ -98280,7 +97803,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98298,9 +97821,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 requestBody: required: false content: @@ -98337,7 +97860,7 @@ paths: description: Response content: application/json: - schema: *577 + schema: *579 examples: default: value: @@ -98873,9 +98396,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 requestBody: required: true content: @@ -98909,7 +98432,7 @@ paths: description: Response content: application/json: - schema: *577 + schema: *579 examples: default: value: @@ -99414,9 +98937,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 - *17 - *19 responses: @@ -99426,7 +98949,7 @@ paths: application/json: schema: type: array - items: &700 + items: &702 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -99495,7 +99018,7 @@ paths: type: string body_text: type: string - author_association: *214 + author_association: *219 required: - id - node_id @@ -99544,7 +99067,7 @@ paths: commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 author_association: COLLABORATOR headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99577,9 +99100,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 requestBody: required: false content: @@ -99665,9 +99188,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *702 examples: - default: &702 + default: &704 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -99730,10 +99253,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *456 - - *457 - - *697 - - &701 + - *462 + - *463 + - *699 + - &703 name: review_id description: The unique identifier of the review. in: path @@ -99745,9 +99268,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *702 examples: - default: &703 + default: &705 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -99806,10 +99329,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *456 - - *457 - - *697 - - *701 + - *462 + - *463 + - *699 + - *703 requestBody: required: true content: @@ -99832,7 +99355,7 @@ paths: description: Response content: application/json: - schema: *700 + schema: *702 examples: default: value: @@ -99894,18 +99417,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *456 - - *457 - - *697 - - *701 + - *462 + - *463 + - *699 + - *703 responses: '200': description: Response content: application/json: - schema: *700 + schema: *702 examples: - default: *702 + default: *704 '422': *7 '404': *6 x-github: @@ -99932,10 +99455,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *456 - - *457 - - *697 - - *701 + - *462 + - *463 + - *699 + - *703 - *17 - *19 responses: @@ -100014,13 +99537,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *214 + author_association: *219 _links: type: object properties: - self: *397 - html: *397 - pull_request: *397 + self: *404 + html: *404 + pull_request: *404 required: - self - html @@ -100029,7 +99552,7 @@ paths: type: string body_html: type: string - reactions: *215 + reactions: *220 side: description: The side of the first line of the range for a multi-line comment. @@ -100141,7 +99664,7 @@ paths: pull_request: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -100170,10 +99693,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *456 - - *457 - - *697 - - *701 + - *462 + - *463 + - *699 + - *703 requestBody: required: true content: @@ -100201,7 +99724,7 @@ paths: description: Response content: application/json: - schema: *700 + schema: *702 examples: default: value: @@ -100264,10 +99787,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *456 - - *457 - - *697 - - *701 + - *462 + - *463 + - *699 + - *703 requestBody: required: true content: @@ -100302,9 +99825,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *702 examples: - default: *703 + default: *705 '404': *6 '422': *7 '403': *29 @@ -100326,9 +99849,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 requestBody: required: false content: @@ -100391,8 +99914,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *456 - - *457 + - *462 + - *463 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -100405,9 +99928,9 @@ paths: description: Response content: application/json: - schema: *704 + schema: *706 examples: - default: &705 + default: &707 value: type: file encoding: base64 @@ -100449,8 +99972,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *456 - - *457 + - *462 + - *463 - name: dir description: The alternate path to look for a README file in: path @@ -100470,9 +99993,9 @@ paths: description: Response content: application/json: - schema: *704 + schema: *706 examples: - default: *705 + default: *707 '404': *6 '422': *15 x-github: @@ -100494,8 +100017,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -100505,7 +100028,7 @@ paths: application/json: schema: type: array - items: &706 + items: &708 title: Release description: A release. type: object @@ -100576,7 +100099,7 @@ paths: author: *4 assets: type: array - items: &707 + items: &709 title: Release Asset description: Data related to a release. type: object @@ -100651,7 +100174,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *215 + reactions: *220 required: - assets_url - upload_url @@ -100743,7 +100266,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -100763,8 +100286,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -100840,9 +100363,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *708 examples: - default: &710 + default: &712 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -100947,9 +100470,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *456 - - *457 - - &708 + - *462 + - *463 + - &710 name: asset_id description: The unique identifier of the asset. in: path @@ -100961,9 +100484,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *709 examples: - default: &709 + default: &711 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 @@ -100998,7 +100521,7 @@ paths: type: User site_admin: false '404': *6 - '302': *588 + '302': *590 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101014,9 +100537,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *456 - - *457 - - *708 + - *462 + - *463 + - *710 requestBody: required: false content: @@ -101044,9 +100567,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *709 examples: - default: *709 + default: *711 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101062,9 +100585,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *456 - - *457 - - *708 + - *462 + - *463 + - *710 responses: '204': description: Response @@ -101088,8 +100611,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -101174,16 +100697,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *706 + schema: *708 examples: - default: *710 + default: *712 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101200,8 +100723,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *456 - - *457 + - *462 + - *463 - name: tag description: tag parameter in: path @@ -101214,9 +100737,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *708 examples: - default: *710 + default: *712 '404': *6 x-github: githubCloudOnly: false @@ -101238,9 +100761,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *456 - - *457 - - &711 + - *462 + - *463 + - &713 name: release_id description: The unique identifier of the release. in: path @@ -101254,9 +100777,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *706 + schema: *708 examples: - default: *710 + default: *712 '401': description: Unauthorized x-github: @@ -101274,9 +100797,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *456 - - *457 - - *711 + - *462 + - *463 + - *713 requestBody: required: false content: @@ -101340,9 +100863,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *708 examples: - default: *710 + default: *712 '404': description: Not Found if the discussion category name is invalid content: @@ -101363,9 +100886,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *456 - - *457 - - *711 + - *462 + - *463 + - *713 responses: '204': description: Response @@ -101385,9 +100908,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *456 - - *457 - - *711 + - *462 + - *463 + - *713 - *17 - *19 responses: @@ -101397,7 +100920,7 @@ paths: application/json: schema: type: array - items: *707 + items: *709 examples: default: value: @@ -101434,7 +100957,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101479,9 +101002,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: - - *456 - - *457 - - *711 + - *462 + - *463 + - *713 - name: name in: query required: true @@ -101507,7 +101030,7 @@ paths: description: Response for successful upload content: application/json: - schema: *707 + schema: *709 examples: response-for-successful-upload: value: @@ -101562,9 +101085,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *456 - - *457 - - *711 + - *462 + - *463 + - *713 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -101588,11 +101111,11 @@ paths: application/json: schema: type: array - items: *445 + items: *453 examples: - default: *447 + default: *455 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -101611,9 +101134,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *456 - - *457 - - *711 + - *462 + - *463 + - *713 requestBody: required: true content: @@ -101643,16 +101166,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '201': description: Reaction created content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -101674,10 +101197,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: + - *462 + - *463 + - *713 - *456 - - *457 - - *711 - - *448 responses: '204': description: Response @@ -101701,9 +101224,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 - *17 - *19 responses: @@ -101719,8 +101242,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *165 - - &712 + - *169 + - &714 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -101739,69 +101262,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *166 - - *712 - - allOf: - - *167 - - *712 - - allOf: - - *168 - - *712 - - allOf: - - *713 - - *712 - - allOf: - - *169 - - *712 - allOf: - *170 - - *712 + - *714 - allOf: - *171 - - *712 + - *714 - allOf: - *172 - - *712 + - *714 + - allOf: + - *715 + - *714 - allOf: - *173 - - *712 + - *714 - allOf: - *174 - - *712 + - *714 - allOf: - *175 - - *712 + - *714 - allOf: - *176 - - *712 + - *714 - allOf: - *177 - - *712 + - *714 - allOf: - *178 - - *712 + - *714 - allOf: - *179 - - *712 + - *714 - allOf: - *180 - - *712 + - *714 - allOf: - *181 - - *712 + - *714 - allOf: - *182 - - *712 + - *714 - allOf: - *183 - - *712 + - *714 - allOf: - *184 - - *712 + - *714 + - allOf: + - *185 + - *714 + - allOf: + - *186 + - *714 + - allOf: + - *187 + - *714 + - allOf: + - *188 + - *714 - allOf: + - *189 - *714 - - *712 examples: default: value: @@ -101840,8 +101363,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 - name: includes_parents @@ -101852,7 +101375,7 @@ paths: schema: type: boolean default: true - - *715 + - *716 responses: '200': description: Response @@ -101860,7 +101383,7 @@ paths: application/json: schema: type: array - items: *185 + items: *190 examples: default: value: @@ -101907,8 +101430,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - - *457 + - *462 + - *463 requestBody: description: Request body required: true @@ -101928,16 +101451,16 @@ paths: - tag - push default: branch - enforcement: *163 + enforcement: *167 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *164 - conditions: *157 + items: *168 + conditions: *161 rules: type: array description: An array of rules within the ruleset. - items: *716 + items: *717 required: - name - enforcement @@ -101968,9 +101491,9 @@ paths: description: Response content: application/json: - schema: *185 + schema: *190 examples: - default: &725 + default: &726 value: id: 42 name: super cool ruleset @@ -102017,12 +101540,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *456 - - *457 - - *717 - - *101 + - *462 + - *463 - *718 + - *105 - *719 + - *720 - *17 - *19 responses: @@ -102030,9 +101553,9 @@ paths: description: Response content: application/json: - schema: *720 + schema: *721 examples: - default: *721 + default: *722 '404': *6 '500': *40 x-github: @@ -102053,17 +101576,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *456 - - *457 - - *722 + - *462 + - *463 + - *723 responses: '200': description: Response content: application/json: - schema: *723 + schema: *724 examples: - default: *724 + default: *725 '404': *6 '500': *40 x-github: @@ -102091,8 +101614,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - - *457 + - *462 + - *463 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102112,9 +101635,9 @@ paths: description: Response content: application/json: - schema: *185 + schema: *190 examples: - default: *725 + default: *726 '404': *6 '500': *40 put: @@ -102132,8 +101655,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - - *457 + - *462 + - *463 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102158,16 +101681,16 @@ paths: - branch - tag - push - enforcement: *163 + enforcement: *167 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *164 - conditions: *157 + items: *168 + conditions: *161 rules: description: An array of rules within the ruleset. type: array - items: *716 + items: *717 examples: default: value: @@ -102195,9 +101718,9 @@ paths: description: Response content: application/json: - schema: *185 + schema: *190 examples: - default: *725 + default: *726 '404': *6 '500': *40 delete: @@ -102215,8 +101738,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - - *457 + - *462 + - *463 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102239,8 +101762,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 - name: ruleset_id @@ -102256,9 +101779,9 @@ paths: application/json: schema: type: array - items: *189 + items: *194 examples: - default: *414 + default: *421 '404': *6 '500': *40 x-github: @@ -102277,8 +101800,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *456 - - *457 + - *462 + - *463 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102296,7 +101819,7 @@ paths: description: Response content: application/json: - schema: *415 + schema: *422 examples: default: value: @@ -102351,21 +101874,22 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *456 - - *457 - - *416 - - *417 - - *418 - - *419 - - *106 + - *462 + - *463 + - *423 + - *424 + - *425 + - *426 + - *427 + - *110 - *19 - *17 - - *726 - *727 - - *420 - - *421 - - *422 - - *423 + - *728 + - *428 + - *429 + - *430 + - *431 responses: '200': description: Response @@ -102373,11 +101897,11 @@ paths: application/json: schema: type: array - items: &731 + items: &732 type: object properties: - number: *123 - created_at: *130 + number: *127 + created_at: *134 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -102385,15 +101909,15 @@ paths: format: date-time readOnly: true nullable: true - url: *128 - html_url: *129 + url: *132 + html_url: *133 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *728 - resolution: *729 + state: *729 + resolution: *730 resolved_at: type: string format: date-time @@ -102489,7 +102013,7 @@ paths: pull request. ' - oneOf: *730 + oneOf: *731 nullable: true has_more_locations: type: boolean @@ -102616,7 +102140,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102638,16 +102162,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *456 - - *457 - - *542 - - *423 + - *462 + - *463 + - *544 + - *431 responses: '200': description: Response content: application/json: - schema: *731 + schema: *732 examples: default: value: @@ -102678,7 +102202,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102689,6 +102213,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. @@ -102699,9 +102225,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *456 - - *457 - - *542 + - *462 + - *463 + - *544 requestBody: required: true content: @@ -102709,27 +102235,42 @@ paths: schema: type: object properties: - state: *728 - resolution: *729 + state: *729 + resolution: *730 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true + assignee: + description: The username of the user to assign to the alert. Set + to `null` to unassign the alert. + type: string + nullable: true 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: *731 + schema: *732 examples: default: value: @@ -102774,6 +102315,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. @@ -102781,8 +102341,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': *190 + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository + '503': *195 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -102804,9 +102365,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *456 - - *457 - - *542 + - *462 + - *463 + - *544 - *19 - *17 responses: @@ -102817,7 +102378,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &912 + items: &920 type: object properties: type: @@ -102843,7 +102404,6 @@ paths: example: commit details: oneOf: - - *732 - *733 - *734 - *735 @@ -102856,6 +102416,7 @@ paths: - *742 - *743 - *744 + - *745 examples: default: value: @@ -102915,11 +102476,11 @@ paths: details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 headers: - Link: *43 + Link: *47 '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102941,8 +102502,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -102950,14 +102511,14 @@ paths: schema: type: object properties: - reason: &746 + reason: &747 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *745 + placeholder_id: *746 required: - reason - placeholder_id @@ -102974,7 +102535,7 @@ paths: schema: type: object properties: - reason: *746 + reason: *747 expire_at: type: string format: date-time @@ -102997,7 +102558,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *190 + '503': *195 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -103020,13 +102581,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *190 + '503': *195 '200': description: Response content: @@ -103036,7 +102597,7 @@ paths: properties: incremental_scans: type: array - items: &747 + items: &748 description: Information on a single scan performed by secret scanning on the repository type: object @@ -103062,15 +102623,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *747 + items: *748 backfill_scans: type: array - items: *747 + items: *748 custom_pattern_backfill_scans: type: array items: allOf: - - *747 + - *748 - type: object properties: pattern_name: @@ -103140,9 +102701,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *456 - - *457 - - *106 + - *462 + - *463 + - *110 - name: sort description: The property to sort the results by. in: query @@ -103154,8 +102715,8 @@ paths: - updated - published default: created - - *104 - - *105 + - *108 + - *109 - name: per_page description: The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -103185,9 +102746,9 @@ paths: application/json: schema: type: array - items: *748 + items: *749 examples: - default: *749 + default: *750 '400': *14 '404': *6 x-github: @@ -103210,8 +102771,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -103284,7 +102845,7 @@ paths: login: type: string description: The username of the user credited. - type: *428 + type: *436 required: - login - type @@ -103371,9 +102932,9 @@ paths: description: Response content: application/json: - schema: *748 + schema: *749 examples: - default: &751 + default: &752 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -103606,8 +103167,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -103711,7 +103272,7 @@ paths: description: Response content: application/json: - schema: *748 + schema: *749 examples: default: value: @@ -103858,17 +103419,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *456 - - *457 - - *750 + - *462 + - *463 + - *751 responses: '200': description: Response content: application/json: - schema: *748 + schema: *749 examples: - default: *751 + default: *752 '403': *29 '404': *6 x-github: @@ -103892,9 +103453,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *456 - - *457 - - *750 + - *462 + - *463 + - *751 requestBody: required: true content: @@ -103967,7 +103528,7 @@ paths: login: type: string description: The username of the user credited. - type: *428 + type: *436 required: - login - type @@ -104053,17 +103614,17 @@ paths: description: Response content: application/json: - schema: *748 + schema: *749 examples: - default: *751 - add_credit: *751 + default: *752 + add_credit: *752 '403': *29 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *249 + schema: *256 examples: invalid_state_transition: value: @@ -104094,9 +103655,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *456 - - *457 - - *750 + - *462 + - *463 + - *751 responses: '202': *39 '400': *14 @@ -104123,9 +103684,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *456 - - *457 - - *750 + - *462 + - *463 + - *751 responses: '202': description: Response @@ -104159,8 +103720,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -104237,7 +103798,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 '422': *15 x-github: githubCloudOnly: false @@ -104259,8 +103820,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -104269,7 +103830,7 @@ paths: application/json: schema: type: array - items: &752 + items: &753 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -104282,7 +103843,7 @@ paths: - 1124 - -435 '202': *39 - '204': *150 + '204': *154 '422': description: Repository contains more than 10,000 commits x-github: @@ -104302,8 +103863,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -104352,7 +103913,7 @@ paths: total: 89 week: 1336280400 '202': *39 - '204': *150 + '204': *154 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104379,8 +103940,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -104454,7 +104015,7 @@ paths: d: 77 c: 10 '202': *39 - '204': *150 + '204': *154 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104476,8 +104037,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -104631,8 +104192,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -104642,7 +104203,7 @@ paths: application/json: schema: type: array - items: *752 + items: *753 examples: default: value: @@ -104655,7 +104216,7 @@ paths: - - 0 - 2 - 21 - '204': *150 + '204': *154 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104675,8 +104236,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *456 - - *457 + - *462 + - *463 - name: sha in: path required: true @@ -104730,7 +104291,7 @@ paths: description: Response content: application/json: - schema: *753 + schema: *754 examples: default: value: @@ -104784,8 +104345,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -104797,9 +104358,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104817,14 +104378,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &754 + schema: &755 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -104892,8 +104453,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: false content: @@ -104919,7 +104480,7 @@ paths: description: Response content: application/json: - schema: *754 + schema: *755 examples: default: value: @@ -104946,8 +104507,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -104967,8 +104528,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -105024,7 +104585,7 @@ paths: tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105047,8 +104608,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -105056,7 +104617,7 @@ paths: application/json: schema: type: array - items: &755 + items: &756 title: Tag protection description: Tag protection type: object @@ -105108,8 +104669,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -105132,7 +104693,7 @@ paths: description: Response content: application/json: - schema: *755 + schema: *756 examples: default: value: @@ -105163,8 +104724,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -105201,8 +104762,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *456 - - *457 + - *462 + - *463 - name: ref in: path required: true @@ -105238,8 +104799,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -105249,11 +104810,11 @@ paths: application/json: schema: type: array - items: *303 + items: *310 examples: - default: *375 + default: *382 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -105271,8 +104832,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *456 - - *457 + - *462 + - *463 - *19 - *17 responses: @@ -105280,7 +104841,7 @@ paths: description: Response content: application/json: - schema: &756 + schema: &757 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -105292,7 +104853,7 @@ paths: required: - names examples: - default: &757 + default: &758 value: names: - octocat @@ -105315,8 +104876,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -105347,9 +104908,9 @@ paths: description: Response content: application/json: - schema: *756 + schema: *757 examples: - default: *757 + default: *758 '404': *6 '422': *7 x-github: @@ -105370,9 +104931,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *456 - - *457 - - &758 + - *462 + - *463 + - &759 name: per description: The time frame to display results for. in: query @@ -105401,7 +104962,7 @@ paths: example: 128 clones: type: array - items: &759 + items: &760 title: Traffic type: object properties: @@ -105488,8 +105049,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -105579,8 +105140,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -105640,9 +105201,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *456 - - *457 - - *758 + - *462 + - *463 + - *759 responses: '200': description: Response @@ -105661,7 +105222,7 @@ paths: example: 3782 views: type: array - items: *759 + items: *760 required: - uniques - count @@ -105738,8 +105299,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -105775,7 +105336,7 @@ paths: description: Response content: application/json: - schema: *274 + schema: *281 examples: default: value: @@ -106013,8 +105574,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -106037,8 +105598,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -106060,8 +105621,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -106087,8 +105648,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *456 - - *457 + - *462 + - *463 - name: ref in: path required: true @@ -106223,7 +105784,7 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: default: value: @@ -106333,7 +105894,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &767 + - &768 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -106342,7 +105903,7 @@ paths: schema: type: string example: members - - &772 + - &773 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -106353,7 +105914,7 @@ paths: default: 1 format: int32 example: 1 - - &773 + - &774 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -106395,7 +105956,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &762 + items: &763 allOf: - type: object required: @@ -106470,7 +106031,7 @@ paths: - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 - meta: &774 + meta: &775 type: object description: The metadata associated with the creation/updates to the user. @@ -106530,30 +106091,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &763 + '400': &764 description: Bad request content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '401': *761 - '403': &764 + schema: *761 + '401': *762 + '403': &765 description: Permission denied - '429': &765 + '429': &766 description: Too many requests content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '500': &766 + schema: *761 + '500': &767 description: Internal server error content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 + schema: *761 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106577,7 +106138,7 @@ paths: required: true content: application/json: - schema: &770 + schema: &771 type: object required: - schemas @@ -106637,9 +106198,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *762 + schema: *763 examples: - group: &768 + group: &769 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -106658,13 +106219,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *763 - '401': *761 - '403': *764 - '409': &771 + '400': *764 + '401': *762 + '403': *765 + '409': &772 description: Duplicate record detected - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106681,7 +106242,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - - &769 + - &770 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -106689,22 +106250,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *767 + - *768 - *41 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *762 + schema: *763 examples: - default: *768 - '400': *763 - '401': *761 - '403': *764 + default: *769 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106723,13 +106284,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - - *769 + - *770 - *41 requestBody: required: true content: application/json: - schema: *770 + schema: *771 examples: group: summary: Group @@ -106755,17 +106316,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *762 + schema: *763 examples: - group: *768 - groupWithMembers: *768 - '400': *763 - '401': *761 - '403': *764 + group: *769 + groupWithMembers: *769 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106789,13 +106350,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - - *769 + - *770 - *41 requestBody: required: true content: application/json: - schema: &781 + schema: &782 type: object required: - Operations @@ -106855,17 +106416,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *762 + schema: *763 examples: - updateGroup: *768 - addMembers: *768 - '400': *763 - '401': *761 - '403': *764 + updateGroup: *769 + addMembers: *769 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106881,17 +106442,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - - *769 + - *770 - *41 responses: '204': description: Group was deleted, no content - '400': *763 - '401': *761 - '403': *764 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106925,8 +106486,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *772 - *773 + - *774 - *41 responses: '200': @@ -106959,7 +106520,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &776 + items: &777 allOf: - type: object required: @@ -107038,7 +106599,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &775 + roles: &776 type: array description: The roles assigned to the user. items: @@ -107094,7 +106655,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *774 + meta: *775 startIndex: type: integer description: A starting index for the returned page @@ -107131,11 +106692,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *763 - '401': *761 - '403': *764 - '429': *765 - '500': *766 + '400': *764 + '401': *762 + '403': *765 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107159,7 +106720,7 @@ paths: required: true content: application/json: - schema: &779 + schema: &780 type: object required: - schemas @@ -107241,9 +106802,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *775 + roles: *776 examples: - user: &780 + user: &781 summary: User value: schemas: @@ -107290,9 +106851,9 @@ paths: description: User has been created content: application/scim+json: - schema: *776 + schema: *777 examples: - user: &777 + user: &778 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -107318,13 +106879,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 - enterpriseOwner: *777 - '400': *763 - '401': *761 - '403': *764 - '409': *771 - '429': *765 - '500': *766 + enterpriseOwner: *778 + '400': *764 + '401': *762 + '403': *765 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107341,7 +106902,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - - &778 + - &779 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -107354,15 +106915,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *776 + schema: *777 examples: - default: *777 - '400': *763 - '401': *761 - '403': *764 + default: *778 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107384,30 +106945,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - - *778 + - *779 - *41 requestBody: required: true content: application/json: - schema: *779 + schema: *780 examples: - user: *780 + user: *781 responses: '200': description: User was updated content: application/scim+json: - schema: *776 + schema: *777 examples: - user: *777 - '400': *763 - '401': *761 - '403': *764 + user: *778 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107442,13 +107003,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - - *778 + - *779 - *41 requestBody: required: true content: application/json: - schema: *781 + schema: *782 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -107488,18 +107049,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *776 + schema: *777 examples: - userMultiValuedProperties: *777 - userSingleValuedProperties: *777 - disableUser: *777 - '400': *763 - '401': *761 - '403': *764 + userMultiValuedProperties: *778 + userSingleValuedProperties: *778 + disableUser: *778 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107519,17 +107080,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - - *778 + - *779 - *41 responses: '204': description: User was deleted, no content - '400': *763 - '401': *761 - '403': *764 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107562,7 +107123,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - - *83 + - *87 - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query @@ -107616,7 +107177,7 @@ paths: example: 1 Resources: type: array - items: &782 + items: &783 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -107847,22 +107408,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *37 - '404': &783 + '404': &784 description: Resource not found content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '403': &784 + schema: *761 + '403': &785 description: Forbidden content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '400': *763 - '429': *765 + schema: *761 + '400': *764 + '429': *766 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -107882,15 +107443,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - - *83 + - *87 responses: '201': description: Response content: application/scim+json: - schema: *782 + schema: *783 examples: - default: &785 + default: &786 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -107913,17 +107474,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *37 - '404': *783 - '403': *784 - '500': *766 + '404': *784 + '403': *785 + '500': *767 '409': description: Conflict content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '400': *763 + schema: *761 + '400': *764 requestBody: required: true content: @@ -108020,18 +107581,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - - *83 - - *778 + - *87 + - *779 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *783 examples: - default: *785 - '404': *783 - '403': *784 + default: *786 + '404': *784 + '403': *785 '304': *37 x-github: githubCloudOnly: true @@ -108054,19 +107615,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - - *83 - - *778 + - *87 + - *779 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *783 examples: - default: *785 + default: *786 '304': *37 - '404': *783 - '403': *784 + '404': *784 + '403': *785 requestBody: required: true content: @@ -108178,20 +107739,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - - *83 - - *778 + - *87 + - *779 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *783 examples: - default: *785 + default: *786 '304': *37 - '404': *783 - '403': *784 - '400': *763 + '404': *784 + '403': *785 + '400': *764 '429': description: Response content: @@ -108281,13 +107842,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - - *83 - - *778 + - *87 + - *779 responses: '204': description: Response - '404': *783 - '403': *784 + '404': *784 + '403': *785 '304': *37 x-github: githubCloudOnly: true @@ -108402,7 +107963,7 @@ paths: html_url: type: string format: uri - repository: *274 + repository: *281 score: type: number file_size: @@ -108420,7 +107981,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &786 + text_matches: &787 title: Search Result Text Matches type: array items: @@ -108534,7 +108095,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *190 + '503': *195 '422': *15 '403': *29 x-github: @@ -108583,7 +108144,7 @@ paths: enum: - author-date - committer-date - - &787 + - &788 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 @@ -108654,7 +108215,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *511 + properties: *513 nullable: true comment_count: type: integer @@ -108674,7 +108235,7 @@ paths: url: type: string format: uri - verification: *633 + verification: *635 required: - author - committer @@ -108693,7 +108254,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *511 + properties: *513 nullable: true parents: type: array @@ -108706,12 +108267,12 @@ paths: type: string sha: type: string - repository: *274 + repository: *281 score: type: number node_id: type: string - text_matches: *786 + text_matches: *787 required: - sha - node_id @@ -108904,7 +108465,7 @@ paths: - interactions - created - updated - - *787 + - *788 - *17 - *19 - name: advanced_search @@ -109001,11 +108562,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: type: string state_reason: @@ -109022,8 +108583,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *395 - required: *396 + properties: *402 + required: *403 nullable: true comments: type: integer @@ -109037,7 +108598,7 @@ paths: type: string format: date-time nullable: true - text_matches: *786 + text_matches: *787 pull_request: type: object properties: @@ -109070,10 +108631,10 @@ paths: type: string score: type: number - author_association: *214 + author_association: *219 draft: type: boolean - repository: *74 + repository: *78 body_html: type: string body_text: @@ -109081,7 +108642,7 @@ paths: timeline_url: type: string format: uri - type: *360 + type: *367 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -109091,9 +108652,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 - reactions: *215 + properties: *217 + required: *218 + reactions: *220 required: - assignee - closed_at @@ -109209,7 +108770,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *190 + '503': *195 '422': *15 '304': *37 '403': *29 @@ -109262,7 +108823,7 @@ paths: enum: - created - updated - - *787 + - *788 - *17 - *19 responses: @@ -109306,7 +108867,7 @@ paths: nullable: true score: type: number - text_matches: *786 + text_matches: *787 required: - id - node_id @@ -109392,7 +108953,7 @@ paths: - forks - help-wanted-issues - updated - - *787 + - *788 - *17 - *19 responses: @@ -109611,8 +109172,8 @@ paths: title: License Simple description: License Simple type: object - properties: *228 - required: *229 + properties: *233 + required: *234 nullable: true permissions: type: object @@ -109631,7 +109192,7 @@ paths: - admin - pull - push - text_matches: *786 + text_matches: *787 temp_clone_token: type: string allow_merge_commit: @@ -109833,7 +109394,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *190 + '503': *195 '422': *15 '304': *37 x-github: @@ -109932,7 +109493,7 @@ paths: type: string format: uri nullable: true - text_matches: *786 + text_matches: *787 related: type: array nullable: true @@ -110125,7 +109686,7 @@ paths: - followers - repositories - joined - - *787 + - *788 - *17 - *19 responses: @@ -110229,7 +109790,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *786 + text_matches: *787 blog: type: string nullable: true @@ -110288,7 +109849,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *190 + '503': *195 '422': *15 x-github: githubCloudOnly: false @@ -110308,7 +109869,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &791 + - &792 name: team_id description: The unique identifier of the team. in: path @@ -110320,9 +109881,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *445 examples: - default: *438 + default: *446 '404': *6 x-github: githubCloudOnly: false @@ -110349,7 +109910,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *791 + - *792 requestBody: required: true content: @@ -110412,16 +109973,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *437 + schema: *445 examples: - default: *438 + default: *446 '201': description: Response content: application/json: - schema: *437 + schema: *445 examples: - default: *438 + default: *446 '404': *6 '422': *15 '403': *29 @@ -110449,7 +110010,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *791 + - *792 responses: '204': description: Response @@ -110480,8 +110041,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *791 - - *106 + - *792 + - *110 - *17 - *19 responses: @@ -110491,11 +110052,11 @@ paths: application/json: schema: type: array - items: *439 + items: *447 examples: - default: *792 + default: *793 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110522,7 +110083,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *791 + - *792 requestBody: required: true content: @@ -110556,9 +110117,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *447 examples: - default: *440 + default: *448 x-github: triggersNotification: true githubCloudOnly: false @@ -110585,16 +110146,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *791 - - *441 + - *792 + - *449 responses: '200': description: Response content: application/json: - schema: *439 + schema: *447 examples: - default: *440 + default: *448 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110619,8 +110180,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *791 - - *441 + - *792 + - *449 requestBody: required: false content: @@ -110643,9 +110204,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *447 examples: - default: *793 + default: *794 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110670,8 +110231,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *791 - - *441 + - *792 + - *449 responses: '204': description: Response @@ -110700,9 +110261,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *791 - - *441 - - *106 + - *792 + - *449 + - *110 - *17 - *19 responses: @@ -110712,11 +110273,11 @@ paths: application/json: schema: type: array - items: *442 + items: *450 examples: - default: *794 + default: *795 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110743,8 +110304,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *791 - - *441 + - *792 + - *449 requestBody: required: true content: @@ -110766,9 +110327,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *450 examples: - default: *443 + default: *451 x-github: triggersNotification: true githubCloudOnly: false @@ -110795,17 +110356,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *792 + - *449 + - *452 responses: '200': description: Response content: application/json: - schema: *442 + schema: *450 examples: - default: *443 + default: *451 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110830,9 +110391,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *792 + - *449 + - *452 requestBody: required: true content: @@ -110854,9 +110415,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *450 examples: - default: *795 + default: *796 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110881,9 +110442,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *792 + - *449 + - *452 responses: '204': description: Response @@ -110912,9 +110473,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *792 + - *449 + - *452 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -110940,11 +110501,11 @@ paths: application/json: schema: type: array - items: *445 + items: *453 examples: - default: *447 + default: *455 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110971,9 +110532,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *792 + - *449 + - *452 requestBody: required: true content: @@ -111005,9 +110566,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111033,8 +110594,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *791 - - *441 + - *792 + - *449 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -111060,11 +110621,11 @@ paths: application/json: schema: type: array - items: *445 + items: *453 examples: - default: *447 + default: *455 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111091,8 +110652,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *791 - - *441 + - *792 + - *449 requestBody: required: true content: @@ -111124,9 +110685,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -111150,7 +110711,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *791 + - *792 - *17 - *19 responses: @@ -111160,11 +110721,11 @@ paths: application/json: schema: type: array - items: *357 + items: *364 examples: - default: *358 + default: *365 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111188,7 +110749,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *791 + - *792 - name: role description: Filters members returned by their role in the team. in: query @@ -111211,9 +110772,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -111239,8 +110800,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *791 - - *138 + - *792 + - *142 responses: '204': description: if user is a member @@ -111276,8 +110837,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *791 - - *138 + - *792 + - *142 responses: '204': description: Response @@ -111316,8 +110877,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *791 - - *138 + - *792 + - *142 responses: '204': description: Response @@ -111353,16 +110914,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *791 - - *138 + - *792 + - *142 responses: '200': description: Response content: application/json: - schema: *453 + schema: *461 examples: - response-if-user-is-a-team-maintainer: *796 + response-if-user-is-a-team-maintainer: *797 '404': *6 x-github: githubCloudOnly: false @@ -111395,8 +110956,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *791 - - *138 + - *792 + - *142 requestBody: required: false content: @@ -111421,9 +110982,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *461 examples: - response-if-users-membership-with-team-is-now-pending: *797 + response-if-users-membership-with-team-is-now-pending: *798 '403': description: Forbidden if team synchronization is set up '422': @@ -111457,8 +111018,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *791 - - *138 + - *792 + - *142 responses: '204': description: Response @@ -111472,174 +111033,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/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy - parameters: - - *791 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *454 - examples: - default: *798 - headers: - Link: *43 - '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/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project-legacy - parameters: - - *791 - - *455 - responses: - '200': - description: Response - content: - application/json: - schema: *454 - examples: - default: *799 - '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/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions-legacy - parameters: - - *791 - - *455 - 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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team-legacy - parameters: - - *791 - - *455 - 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) @@ -111653,7 +111046,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *791 + - *792 - *17 - *19 responses: @@ -111663,11 +111056,11 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: *382 + default: *389 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -111695,15 +111088,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *791 - - *456 - - *457 + - *792 + - *462 + - *463 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *800 + schema: *799 examples: alternative-response-with-extra-repository-information: value: @@ -111854,9 +111247,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *791 - - *456 - - *457 + - *792 + - *462 + - *463 requestBody: required: false content: @@ -111906,9 +111299,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *791 - - *456 - - *457 + - *792 + - *462 + - *463 responses: '204': description: Response @@ -111937,15 +111330,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - - *791 + - *792 responses: '200': description: Response content: application/json: - schema: *458 + schema: *464 examples: - default: *459 + default: *465 '403': *29 '404': *6 x-github: @@ -111972,7 +111365,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - - *791 + - *792 requestBody: required: true content: @@ -112029,7 +111422,7 @@ paths: description: Response content: application/json: - schema: *458 + schema: *464 examples: default: value: @@ -112060,7 +111453,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *791 + - *792 - *17 - *19 responses: @@ -112070,11 +111463,11 @@ paths: application/json: schema: type: array - items: *303 + items: *310 examples: - response-if-child-teams-exist: *801 + response-if-child-teams-exist: *800 headers: - Link: *43 + Link: *47 '404': *6 '403': *29 '422': *15 @@ -112105,7 +111498,7 @@ paths: application/json: schema: oneOf: - - &803 + - &802 title: Private User description: Private User type: object @@ -112308,7 +111701,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *802 + - *801 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -112461,7 +111854,7 @@ paths: description: Response content: application/json: - schema: *803 + schema: *802 examples: default: value: @@ -112540,7 +111933,7 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 '304': *37 '404': *6 '403': *29 @@ -112563,7 +111956,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *138 + - *142 responses: '204': description: If the user is blocked @@ -112591,7 +111984,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - - *138 + - *142 responses: '204': description: Response @@ -112615,7 +112008,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - - *138 + - *142 responses: '204': description: Response @@ -112664,9 +112057,9 @@ paths: type: integer codespaces: type: array - items: *365 + items: *372 examples: - default: *366 + default: *373 '304': *37 '500': *40 '401': *25 @@ -112805,21 +112198,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '401': *25 '403': *29 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112859,7 +112252,7 @@ paths: type: integer secrets: type: array - items: &804 + items: &803 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -112899,9 +112292,9 @@ paths: - visibility - selected_repositories_url examples: - default: *565 + default: *567 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112969,13 +112362,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *284 + - *291 responses: '200': description: Response content: application/json: - schema: *804 + schema: *803 examples: default: value: @@ -113005,7 +112398,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *284 + - *291 requestBody: required: true content: @@ -113050,7 +112443,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -113078,7 +112471,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *284 + - *291 responses: '204': description: Response @@ -113103,7 +112496,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *284 + - *291 responses: '200': description: Response @@ -113119,9 +112512,9 @@ paths: type: integer repositories: type: array - items: *274 + items: *281 examples: - default: *805 + default: *804 '401': *25 '403': *29 '404': *6 @@ -113146,7 +112539,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *284 + - *291 requestBody: required: true content: @@ -113200,7 +112593,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *284 + - *291 - name: repository_id in: path required: true @@ -113233,7 +112626,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *284 + - *291 - name: repository_id in: path required: true @@ -113265,15 +112658,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *367 + - *374 responses: '200': description: Response content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '304': *37 '500': *40 '401': *25 @@ -113299,7 +112692,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *367 + - *374 requestBody: required: false content: @@ -113329,9 +112722,9 @@ paths: description: Response content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '401': *25 '403': *29 '404': *6 @@ -113353,7 +112746,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *367 + - *374 responses: '202': *39 '304': *37 @@ -113382,13 +112775,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *367 + - *374 responses: '202': description: Response content: application/json: - schema: &806 + schema: &805 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -113429,7 +112822,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &807 + default: &806 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -113461,7 +112854,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *367 + - *374 - name: export_id in: path required: true @@ -113474,9 +112867,9 @@ paths: description: Response content: application/json: - schema: *806 + schema: *805 examples: - default: *807 + default: *806 '404': *6 x-github: githubCloudOnly: false @@ -113497,7 +112890,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *367 + - *374 responses: '200': description: Response @@ -113513,9 +112906,9 @@ paths: type: integer machines: type: array - items: *808 + items: *807 examples: - default: *809 + default: *808 '304': *37 '500': *40 '401': *25 @@ -113544,7 +112937,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *367 + - *374 requestBody: required: true content: @@ -113599,8 +112992,8 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *563 - required: *564 + properties: *565 + required: *566 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -114374,15 +113767,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *367 + - *374 responses: '200': description: Response content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '304': *37 '500': *40 '400': *14 @@ -114394,7 +113787,7 @@ paths: schema: *3 '403': *29 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -114414,15 +113807,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *367 + - *374 responses: '200': description: Response content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '500': *40 '401': *25 '403': *29 @@ -114452,9 +113845,9 @@ paths: application/json: schema: type: array - items: *376 + items: *383 examples: - default: &820 + default: &819 value: - id: 197 name: hello_docker @@ -114555,7 +113948,7 @@ paths: application/json: schema: type: array - items: &810 + items: &809 title: Email description: Email type: object @@ -114620,16 +114013,16 @@ paths: application/json: schema: type: array - items: *810 + items: *809 examples: - default: &822 + default: &821 value: - email: octocat@github.com verified: true primary: true visibility: public headers: - Link: *43 + Link: *47 '304': *37 '404': *6 '403': *29 @@ -114697,7 +114090,7 @@ paths: application/json: schema: type: array - items: *810 + items: *809 examples: default: value: @@ -114807,9 +114200,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -114840,9 +114233,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -114862,7 +114255,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *138 + - *142 responses: '204': description: if the person is followed by the authenticated user @@ -114892,7 +114285,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - - *138 + - *142 responses: '204': description: Response @@ -114917,7 +114310,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - - *138 + - *142 responses: '204': description: Response @@ -114953,7 +114346,7 @@ paths: application/json: schema: type: array - items: &811 + items: &810 title: GPG Key description: A unique encryption key type: object @@ -115084,7 +114477,7 @@ paths: - subkeys - revoked examples: - default: &836 + default: &835 value: - id: 3 name: Octocat's GPG Key @@ -115116,7 +114509,7 @@ paths: revoked: false raw_key: string headers: - Link: *43 + Link: *47 '304': *37 '404': *6 '403': *29 @@ -115169,9 +114562,9 @@ paths: description: Response content: application/json: - schema: *811 + schema: *810 examples: - default: &812 + default: &811 value: id: 3 name: Octocat's GPG Key @@ -115228,7 +114621,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &813 + - &812 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -115240,9 +114633,9 @@ paths: description: Response content: application/json: - schema: *811 + schema: *810 examples: - default: *812 + default: *811 '404': *6 '304': *37 '403': *29 @@ -115265,7 +114658,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *813 + - *812 responses: '204': description: Response @@ -115408,7 +114801,7 @@ paths: suspended_at: suspended_by: headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -115454,11 +114847,11 @@ paths: type: string repositories: type: array - items: *74 + items: *78 examples: - default: *269 + default: *276 headers: - Link: *43 + Link: *47 '404': *6 '403': *29 '304': *37 @@ -115481,7 +114874,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *268 + - *275 responses: '204': description: Response @@ -115507,7 +114900,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *268 + - *275 responses: '204': description: Response @@ -115541,12 +114934,12 @@ paths: application/json: schema: anyOf: - - *355 + - *362 - type: object properties: {} additionalProperties: false examples: - default: *356 + default: *363 '204': description: Response when there are no restrictions x-github: @@ -115570,7 +114963,7 @@ paths: required: true content: application/json: - schema: *644 + schema: *646 examples: default: value: @@ -115581,7 +114974,7 @@ paths: description: Response content: application/json: - schema: *355 + schema: *362 examples: default: value: @@ -115662,7 +115055,7 @@ paths: - closed - all default: open - - *363 + - *370 - name: sort description: What to sort results by. in: query @@ -115674,8 +115067,8 @@ paths: - updated - comments default: created - - *106 - - *217 + - *110 + - *222 - *17 - *19 responses: @@ -115685,11 +115078,11 @@ paths: application/json: schema: type: array - items: *227 + items: *232 examples: - default: *364 + default: *371 headers: - Link: *43 + Link: *47 '404': *6 '304': *37 x-github: @@ -115720,7 +115113,7 @@ paths: application/json: schema: type: array - items: &814 + items: &813 title: Key description: Key type: object @@ -115771,7 +115164,7 @@ paths: verified: false read_only: false headers: - Link: *43 + Link: *47 '304': *37 '404': *6 '403': *29 @@ -115821,9 +115214,9 @@ paths: description: Response content: application/json: - schema: *814 + schema: *813 examples: - default: &815 + default: &814 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -115856,15 +115249,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *674 + - *676 responses: '200': description: Response content: application/json: - schema: *814 + schema: *813 examples: - default: *815 + default: *814 '404': *6 '304': *37 '403': *29 @@ -115887,7 +115280,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *674 + - *676 responses: '204': description: Response @@ -115920,7 +115313,7 @@ paths: application/json: schema: type: array - items: &816 + items: &815 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -115977,7 +115370,7 @@ paths: - id - type - login - plan: *231 + plan: *236 required: - billing_cycle - next_billing_date @@ -115988,7 +115381,7 @@ paths: - account - plan examples: - default: &817 + default: &816 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -116021,7 +115414,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *43 + Link: *47 '304': *37 '401': *25 '404': *6 @@ -116050,11 +115443,11 @@ paths: application/json: schema: type: array - items: *816 + items: *815 examples: - default: *817 + default: *816 headers: - Link: *43 + Link: *47 '304': *37 '401': *25 x-github: @@ -116092,7 +115485,7 @@ paths: application/json: schema: type: array - items: *368 + items: *375 examples: default: value: @@ -116169,7 +115562,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -116194,13 +115587,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *368 + schema: *375 examples: default: value: @@ -116258,7 +115651,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *83 + - *87 requestBody: required: true content: @@ -116283,7 +115676,7 @@ paths: description: Response content: application/json: - schema: *368 + schema: *375 examples: default: value: @@ -116351,7 +115744,7 @@ paths: application/json: schema: type: array - items: *370 + items: *377 examples: default: value: @@ -116504,7 +115897,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -116604,7 +115997,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *377 examples: default: value: @@ -116784,7 +116177,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *371 + - *378 - name: exclude in: query required: false @@ -116797,7 +116190,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *377 examples: default: value: @@ -116991,7 +116384,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *371 + - *378 responses: '302': description: Response @@ -117017,7 +116410,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *371 + - *378 responses: '204': description: Response @@ -117046,8 +116439,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *371 - - *818 + - *378 + - *817 responses: '204': description: Response @@ -117071,7 +116464,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *371 + - *378 - *17 - *19 responses: @@ -117081,11 +116474,11 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: *382 + default: *389 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -117118,11 +116511,11 @@ paths: application/json: schema: type: array - items: *69 + items: *73 examples: - default: *244 + default: *249 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -117162,7 +116555,7 @@ paths: - docker - nuget - container - - *819 + - *818 - *19 - *17 responses: @@ -117172,10 +116565,10 @@ paths: application/json: schema: type: array - items: *376 + items: *383 examples: - default: *820 - '400': *821 + default: *819 + '400': *820 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -117195,16 +116588,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *378 - - *379 + - *385 + - *386 responses: '200': description: Response content: application/json: - schema: *376 + schema: *383 examples: - default: &837 + default: &836 value: id: 40201 name: octo-name @@ -117317,8 +116710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *378 - - *379 + - *385 + - *386 responses: '204': description: Response @@ -117348,8 +116741,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *378 - - *379 + - *385 + - *386 - name: token description: package token schema: @@ -117381,8 +116774,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *378 - - *379 + - *385 + - *386 - *19 - *17 - name: state @@ -117402,7 +116795,7 @@ paths: application/json: schema: type: array - items: *380 + items: *387 examples: default: value: @@ -117451,15 +116844,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *378 - - *379 - - *381 + - *385 + - *386 + - *388 responses: '200': description: Response content: application/json: - schema: *380 + schema: *387 examples: default: value: @@ -117495,9 +116888,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *378 - - *379 - - *381 + - *385 + - *386 + - *388 responses: '204': description: Response @@ -117527,9 +116920,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *378 - - *379 - - *381 + - *385 + - *386 + - *388 responses: '204': description: Response @@ -117566,11 +116959,11 @@ paths: application/json: schema: type: array - items: *810 + items: *809 examples: - default: *822 + default: *821 headers: - Link: *43 + Link: *47 '304': *37 '404': *6 '403': *29 @@ -117679,9 +117072,9 @@ paths: application/json: schema: type: array - items: *74 + items: *78 examples: - default: &829 + default: &828 summary: Default response value: - id: 1296269 @@ -117802,7 +117195,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *43 + Link: *47 '422': *15 '304': *37 '403': *29 @@ -118025,11 +117418,11 @@ paths: application/json: schema: type: array - items: *646 + items: *648 examples: - default: *823 + default: *822 headers: - Link: *43 + Link: *47 '304': *37 '404': *6 '403': *29 @@ -118050,12 +117443,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *359 + - *366 responses: '204': description: Response '403': *29 - '409': *114 + '409': *118 '404': *6 '304': *37 x-github: @@ -118073,11 +117466,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *359 + - *366 responses: '204': description: Response - '409': *114 + '409': *118 '304': *37 '404': *6 '403': *29 @@ -118106,7 +117499,7 @@ paths: application/json: schema: type: array - items: &824 + items: &823 title: Social account description: Social media account type: object @@ -118121,12 +117514,12 @@ paths: - provider - url examples: - default: &825 + default: &824 value: - provider: twitter url: https://twitter.com/github headers: - Link: *43 + Link: *47 '304': *37 '404': *6 '403': *29 @@ -118183,9 +117576,9 @@ paths: application/json: schema: type: array - items: *824 + items: *823 examples: - default: *825 + default: *824 '422': *15 '304': *37 '404': *6 @@ -118272,7 +117665,7 @@ paths: application/json: schema: type: array - items: &826 + items: &825 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -118292,7 +117685,7 @@ paths: - title - created_at examples: - default: &841 + default: &849 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -118303,7 +117696,7 @@ paths: title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' headers: - Link: *43 + Link: *47 '304': *37 '404': *6 '403': *29 @@ -118356,9 +117749,9 @@ paths: description: Response content: application/json: - schema: *826 + schema: *825 examples: - default: &827 + default: &826 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -118388,7 +117781,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &828 + - &827 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -118400,9 +117793,9 @@ paths: description: Response content: application/json: - schema: *826 + schema: *825 examples: - default: *827 + default: *826 '404': *6 '304': *37 '403': *29 @@ -118425,7 +117818,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *828 + - *827 responses: '204': description: Response @@ -118454,7 +117847,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &842 + - &850 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 @@ -118467,7 +117860,7 @@ paths: - created - updated default: created - - *106 + - *110 - *17 - *19 responses: @@ -118477,13 +117870,13 @@ paths: application/json: schema: type: array - items: *74 + items: *78 examples: - default-response: *829 + default-response: *828 application/vnd.github.v3.star+json: schema: type: array - items: &843 + items: &851 title: Starred Repository description: Starred Repository type: object @@ -118491,7 +117884,7 @@ paths: starred_at: type: string format: date-time - repo: *74 + repo: *78 required: - starred_at - repo @@ -118619,7 +118012,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -118639,8 +118032,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response if this repository is starred by you @@ -118668,8 +118061,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -118693,8 +118086,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -118727,11 +118120,11 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: *382 + default: *389 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -118766,7 +118159,7 @@ paths: application/json: schema: type: array - items: *437 + items: *445 examples: default: value: @@ -118817,7 +118210,7 @@ paths: updated_at: '2017-08-17T12:37:15Z' type: Organization headers: - Link: *43 + Link: *47 '304': *37 '404': *6 '403': *29 @@ -118844,7 +118237,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *233 + - *238 responses: '200': description: Response @@ -118852,10 +118245,10 @@ paths: application/json: schema: oneOf: - - *803 - *802 + - *801 examples: - default-response: &831 + default-response: &830 summary: Default response value: login: octocat @@ -118890,7 +118283,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &832 + response-with-git-hub-plan-information: &831 summary: Response with GitHub plan information value: login: octocat @@ -118953,7 +118346,7 @@ paths: required: true schema: type: string - - *394 + - *401 requestBody: required: true description: Details of the draft item to create in the project. @@ -118987,9 +118380,9 @@ paths: description: Response content: application/json: - schema: *400 + schema: *407 examples: - draft_issue: *401 + draft_issue: *408 '304': *37 '403': *29 '401': *25 @@ -119012,7 +118405,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *830 + - *829 - *17 responses: '200': @@ -119023,7 +118416,7 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: Link: example: ; rel="next" @@ -119053,7 +118446,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - - *138 + - *142 responses: '200': description: Response @@ -119061,11 +118454,11 @@ paths: application/json: schema: oneOf: - - *803 - *802 + - *801 examples: - default-response: *831 - response-with-git-hub-plan-information: *832 + default-response: *830 + response-with-git-hub-plan-information: *831 '404': *6 x-github: githubCloudOnly: false @@ -119089,9 +118482,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *104 - - *105 - - *138 + - *108 + - *109 + - *142 requestBody: required: true content: @@ -119115,8 +118508,8 @@ paths: required: - subject_digests examples: - default: *833 - withPredicateType: *834 + default: *832 + withPredicateType: *833 responses: '200': description: Response @@ -119169,7 +118562,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *835 + default: *834 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119187,7 +118580,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-in-bulk parameters: - - *138 + - *142 requestBody: required: true content: @@ -119252,7 +118645,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *138 + - *142 - name: subject_digest description: Subject Digest in: path @@ -119283,7 +118676,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-id parameters: - - *138 + - *142 - name: attestation_id description: Attestation ID in: path @@ -119319,9 +118712,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations parameters: - *17 - - *104 - - *105 - - *138 + - *108 + - *109 + - *142 - name: subject_digest description: Subject Digest in: path @@ -119374,12 +118767,12 @@ paths: initiator: type: string examples: - default: *507 + default: *509 '201': description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -119405,7 +118798,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *138 + - *142 responses: '200': description: Response @@ -119413,9 +118806,9 @@ paths: application/json: schema: type: array - items: *376 + items: *383 examples: - default: *820 + default: *819 '403': *29 '401': *25 x-github: @@ -119438,7 +118831,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -119448,7 +118841,7 @@ paths: application/json: schema: type: array - items: *239 + items: *244 examples: default: value: @@ -119510,8 +118903,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *138 - - *83 + - *142 + - *87 - *17 - *19 responses: @@ -119521,7 +118914,7 @@ paths: application/json: schema: type: array - items: *239 + items: *244 examples: default: value: @@ -119598,7 +118991,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -119608,7 +119001,7 @@ paths: application/json: schema: type: array - items: *239 + items: *244 examples: default: value: @@ -119666,7 +119059,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -119678,9 +119071,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119697,7 +119090,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - - *138 + - *142 - *17 - *19 responses: @@ -119709,9 +119102,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119728,7 +119121,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-user-follows-another-user parameters: - - *138 + - *142 - name: target_user in: path required: true @@ -119755,8 +119148,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - - *138 - - *217 + - *142 + - *222 - *17 - *19 responses: @@ -119766,11 +119159,11 @@ paths: application/json: schema: type: array - items: *218 + items: *223 examples: - default: *219 + default: *224 headers: - Link: *43 + Link: *47 '422': *15 x-github: githubCloudOnly: false @@ -119789,7 +119182,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -119799,11 +119192,11 @@ paths: application/json: schema: type: array - items: *811 + items: *810 examples: - default: *836 + default: *835 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119825,7 +119218,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - - *138 + - *142 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -119897,7 +119290,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *138 + - *142 responses: '200': description: Response @@ -119905,7 +119298,7 @@ paths: application/json: schema: *22 examples: - default: *643 + default: *645 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -119923,7 +119316,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -119958,7 +119351,7 @@ paths: - id: 1 key: ssh-rsa AAA... headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119978,7 +119371,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -119988,11 +119381,11 @@ paths: application/json: schema: type: array - items: *69 + items: *73 examples: - default: *244 + default: *249 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -120029,8 +119422,8 @@ paths: - docker - nuget - container - - *819 - - *138 + - *818 + - *142 - *19 - *17 responses: @@ -120040,12 +119433,12 @@ paths: application/json: schema: type: array - items: *376 + items: *383 examples: - default: *820 + default: *819 '403': *29 '401': *25 - '400': *821 + '400': *820 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120065,17 +119458,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *378 - - *379 - - *138 + - *385 + - *386 + - *142 responses: '200': description: Response content: application/json: - schema: *376 + schema: *383 examples: - default: *837 + default: *836 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120096,9 +119489,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *378 - - *379 - - *138 + - *385 + - *386 + - *142 responses: '204': description: Response @@ -120130,9 +119523,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *378 - - *379 - - *138 + - *385 + - *386 + - *142 - name: token description: package token schema: @@ -120164,9 +119557,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *378 - - *379 - - *138 + - *385 + - *386 + - *142 responses: '200': description: Response @@ -120174,7 +119567,7 @@ paths: application/json: schema: type: array - items: *380 + items: *387 examples: default: value: @@ -120232,16 +119625,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-a-user parameters: - - *378 - - *379 - - *381 - - *138 + - *385 + - *386 + - *388 + - *142 responses: '200': description: Response content: application/json: - schema: *380 + schema: *387 examples: default: value: @@ -120276,10 +119669,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *378 - - *379 - - *138 - - *381 + - *385 + - *386 + - *142 + - *388 responses: '204': description: Response @@ -120311,10 +119704,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *378 - - *379 - - *138 - - *381 + - *385 + - *386 + - *142 + - *388 responses: '204': description: Response @@ -120338,15 +119731,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-user parameters: - - *138 + - *142 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *104 - - *105 + - *108 + - *109 - *17 responses: '200': @@ -120355,11 +119748,11 @@ paths: application/json: schema: type: array - items: *392 + items: *399 examples: - default: *393 + default: *400 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -120379,18 +119772,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-user parameters: - - *394 - - *138 + - *401 + - *142 responses: '200': description: Response content: application/json: - schema: *392 + schema: *399 examples: - default: *393 + default: *400 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -120410,11 +119803,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-user parameters: - - *394 - - *138 + - *401 + - *142 - *17 - - *104 - - *105 + - *108 + - *109 responses: '200': description: Response @@ -120422,11 +119815,11 @@ paths: application/json: schema: type: array - items: *398 + items: *405 examples: - default: *838 + default: *837 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -120435,6 +119828,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/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project + parameters: + - *142 + - *401 + 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: *838 + 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: *839 + 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: *840 + iteration_field: *841 + responses: + '201': + description: Response + content: + application/json: + schema: *405 + examples: + text_field: *842 + number_field: *843 + date_field: *844 + single_select_field: *845 + iteration_field: *846 + '304': *37 + '403': *29 + '401': *25 + '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 @@ -120446,19 +119949,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - - *394 - - *839 - - *138 + - *401 + - *847 + - *142 responses: '200': description: Response content: application/json: - schema: *398 + schema: *405 examples: - default: *840 + default: *848 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -120479,10 +119982,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-owned-project parameters: - - *394 - - *138 - - *104 - - *105 + - *401 + - *142 + - *108 + - *109 - *17 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) @@ -120512,11 +120015,11 @@ paths: application/json: schema: type: array - items: *402 + items: *409 examples: - default: *403 + default: *410 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -120535,8 +120038,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-user-owned-project parameters: - - *138 - - *394 + - *142 + - *401 requestBody: required: true description: Details of the item to add to the project. @@ -120573,10 +120076,10 @@ paths: description: Response content: application/json: - schema: *400 + schema: *407 examples: - issue: *401 - pull_request: *401 + issue: *408 + pull_request: *408 '304': *37 '403': *29 '401': *25 @@ -120596,9 +120099,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *394 - - *138 - - *404 + - *401 + - *142 + - *411 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -120618,11 +120121,11 @@ paths: description: Response content: application/json: - schema: *402 + schema: *409 examples: - default: *403 + default: *410 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -120641,9 +120144,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-user parameters: - - *394 - - *138 - - *404 + - *401 + - *142 + - *411 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -120713,13 +120216,13 @@ paths: description: Response content: application/json: - schema: *402 + schema: *409 examples: - text_field: *403 - number_field: *403 - date_field: *403 - single_select_field: *403 - iteration_field: *403 + text_field: *410 + number_field: *410 + date_field: *410 + single_select_field: *410 + iteration_field: *410 '401': *25 '403': *29 '404': *6 @@ -120739,9 +120242,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-user parameters: - - *394 - - *138 - - *404 + - *401 + - *142 + - *411 responses: '204': description: Response @@ -120768,7 +120271,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -120778,7 +120281,7 @@ paths: application/json: schema: type: array - items: *239 + items: *244 examples: default: value: @@ -120843,7 +120346,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-received-by-a-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -120853,7 +120356,7 @@ paths: application/json: schema: type: array - items: *239 + items: *244 examples: default: value: @@ -120916,7 +120419,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - - *138 + - *142 - name: type description: Limit results to repositories of the specified type. in: query @@ -120959,11 +120462,11 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: *382 + default: *389 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -120981,7 +120484,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -120991,11 +120494,11 @@ paths: application/json: schema: type: array - items: *824 + items: *823 examples: - default: *825 + default: *824 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -121013,7 +120516,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -121023,11 +120526,11 @@ paths: application/json: schema: type: array - items: *826 + items: *825 examples: - default: *841 + default: *849 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -121049,9 +120552,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *138 - - *842 - - *106 + - *142 + - *850 + - *110 - *17 - *19 responses: @@ -121062,13 +120565,13 @@ paths: schema: anyOf: - type: array - items: *843 + items: *851 - type: array - items: *74 + items: *78 examples: - default-response: *829 + default-response: *828 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -121085,7 +120588,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -121095,11 +120598,11 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: *382 + default: *389 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -121225,7 +120728,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &844 + enterprise: &852 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -121283,7 +120786,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &845 + installation: &853 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -121302,7 +120805,7 @@ x-webhooks: required: - id - node_id - organization: &846 + organization: &854 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -121362,13 +120865,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &847 + repository: &855 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &884 + properties: &892 id: description: Unique identifier of the repository example: 42 @@ -121388,8 +120891,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *228 - required: *229 + properties: *233 + required: *234 nullable: true organization: title: Simple User @@ -122051,7 +121554,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &885 + required: &893 - archive_url - assignees_url - blobs_url @@ -122202,10 +121705,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -122281,11 +121784,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - rule: &848 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + rule: &856 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -122508,11 +122011,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - rule: *848 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + rule: *856 sender: *4 required: - action @@ -122695,11 +122198,11 @@ x-webhooks: - everyone required: - from - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - rule: *848 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + rule: *856 sender: *4 required: - action @@ -122772,7 +122275,7 @@ x-webhooks: required: true content: application/json: - schema: &868 + schema: &876 title: Exemption request cancellation event type: object properties: @@ -122780,11 +122283,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: &849 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + exemption_request: &857 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -123017,7 +122520,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &850 + items: &858 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -123127,7 +122630,7 @@ x-webhooks: required: true content: application/json: - schema: &869 + schema: &877 title: Exemption request completed event type: object properties: @@ -123135,11 +122638,11 @@ x-webhooks: type: string enum: - completed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + exemption_request: *857 sender: *4 required: - action @@ -123211,7 +122714,7 @@ x-webhooks: required: true content: application/json: - schema: &866 + schema: &874 title: Exemption request created event type: object properties: @@ -123219,11 +122722,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + exemption_request: *857 sender: *4 required: - action @@ -123295,7 +122798,7 @@ x-webhooks: required: true content: application/json: - schema: &870 + schema: &878 title: Exemption response dismissed event type: object properties: @@ -123303,12 +122806,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 - exemption_response: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + exemption_request: *857 + exemption_response: *858 sender: *4 required: - action @@ -123382,7 +122885,7 @@ x-webhooks: required: true content: application/json: - schema: &867 + schema: &875 title: Exemption response submitted event type: object properties: @@ -123390,12 +122893,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 - exemption_response: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + exemption_request: *857 + exemption_response: *858 sender: *4 required: - action @@ -123479,7 +122982,7 @@ x-webhooks: type: string enum: - completed - check_run: &852 + check_run: &860 title: CheckRun description: A check performed on the code of a given code change type: object @@ -123532,8 +123035,8 @@ x-webhooks: type: string pull_requests: type: array - items: *524 - repository: *274 + items: *526 + repository: *281 status: example: completed type: string @@ -123570,7 +123073,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *851 + deployment: *859 details_url: example: https://example.com type: string @@ -123620,7 +123123,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *524 + items: *526 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -123655,10 +123158,10 @@ x-webhooks: - output - app - pull_requests - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + installation: *853 + enterprise: *852 + organization: *854 + repository: *855 sender: *4 required: - check_run @@ -124051,11 +123554,11 @@ x-webhooks: type: string enum: - created - check_run: *852 - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + check_run: *860 + installation: *853 + enterprise: *852 + organization: *854 + repository: *855 sender: *4 required: - check_run @@ -124451,11 +123954,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *852 - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + check_run: *860 + installation: *853 + enterprise: *852 + organization: *854 + repository: *855 requested_action: description: The action requested by the user. type: object @@ -124860,11 +124363,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *852 - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + check_run: *860 + installation: *853 + enterprise: *852 + organization: *854 + repository: *855 sender: *4 required: - check_run @@ -125841,10 +125344,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -126117,6 +125620,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -126529,10 +126037,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -126800,6 +126308,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -127211,10 +126724,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -127380,7 +126893,7 @@ x-webhooks: required: - login - id - dismissed_comment: *537 + dismissed_comment: *539 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -127525,20 +127038,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &853 + commit_oid: &861 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: *844 - installation: *845 - organization: *846 - ref: &854 + enterprise: *852 + installation: *853 + organization: *854 + ref: &862 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: *847 + repository: *855 sender: *4 required: - action @@ -127703,7 +127216,7 @@ x-webhooks: required: - login - id - dismissed_comment: *537 + dismissed_comment: *539 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -127933,12 +127446,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *861 + enterprise: *852 + installation: *853 + organization: *854 + ref: *862 + repository: *855 sender: *4 required: - action @@ -128033,7 +127546,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *537 + dismissed_comment: *539 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -128204,12 +127717,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *861 + enterprise: *852 + installation: *853 + organization: *854 + ref: *862 + repository: *855 sender: *4 required: - action @@ -128375,7 +127888,7 @@ x-webhooks: required: - login - id - dismissed_comment: *537 + dismissed_comment: *539 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -128541,12 +128054,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *861 + enterprise: *852 + installation: *853 + organization: *854 + ref: *862 + repository: *855 sender: *4 required: - action @@ -128646,7 +128159,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *537 + dismissed_comment: *539 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -128814,16 +128327,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *847 + repository: *855 sender: *4 required: - action @@ -128920,7 +128433,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *537 + dismissed_comment: *539 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -129060,12 +128573,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *861 + enterprise: *852 + installation: *853 + organization: *854 + ref: *862 + repository: *855 sender: *4 required: - action @@ -129322,10 +128835,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -129405,18 +128918,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *846 - pusher_type: &855 + organization: *854 + pusher_type: &863 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &856 + ref: &864 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -129426,7 +128939,7 @@ x-webhooks: enum: - tag - branch - repository: *847 + repository: *855 sender: *4 required: - ref @@ -129508,10 +129021,10 @@ x-webhooks: type: string enum: - created - definition: *152 - enterprise: *844 - installation: *845 - organization: *846 + definition: *156 + enterprise: *852 + installation: *853 + organization: *854 sender: *4 required: - action @@ -129596,9 +129109,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 sender: *4 required: - action @@ -129675,10 +129188,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *152 - enterprise: *844 - installation: *845 - organization: *846 + definition: *156 + enterprise: *852 + installation: *853 + organization: *854 sender: *4 required: - action @@ -129755,10 +129268,10 @@ x-webhooks: type: string enum: - updated - definition: *152 - enterprise: *844 - installation: *845 - organization: *846 + definition: *156 + enterprise: *852 + installation: *853 + organization: *854 sender: *4 required: - action @@ -129835,19 +129348,19 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - repository: *847 - organization: *846 + enterprise: *852 + installation: *853 + repository: *855 + organization: *854 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *151 + items: *155 old_property_values: type: array description: The old custom property values for the repository. - items: *151 + items: *155 required: - action - repository @@ -129923,18 +129436,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - pusher_type: *855 - ref: *856 + enterprise: *852 + installation: *853 + organization: *854 + pusher_type: *863 + ref: *864 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *847 + repository: *855 sender: *4 required: - ref @@ -130018,11 +129531,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *595 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -130106,11 +129619,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *595 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -130194,11 +129707,11 @@ x-webhooks: type: string enum: - created - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *595 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -130280,11 +129793,11 @@ x-webhooks: type: string enum: - dismissed - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *595 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -130366,11 +129879,11 @@ x-webhooks: type: string enum: - fixed - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *595 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -130453,11 +129966,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *595 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -130539,11 +130052,11 @@ x-webhooks: type: string enum: - reopened - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *595 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -130620,9 +130133,9 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - key: &857 + enterprise: *852 + installation: *853 + key: &865 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -130658,8 +130171,8 @@ x-webhooks: - verified - created_at - read_only - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -130736,11 +130249,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - key: *857 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + key: *865 + organization: *854 + repository: *855 sender: *4 required: - action @@ -131301,12 +130814,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - workflow: &861 + workflow: &869 title: Workflow type: object nullable: true @@ -132032,13 +131545,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *599 + deployment: *601 pull_requests: type: array - items: *695 - repository: *847 - organization: *846 - installation: *845 + items: *697 + repository: *855 + organization: *854 + installation: *853 sender: *4 responses: '200': @@ -132109,7 +131622,7 @@ x-webhooks: type: string enum: - approved - approver: &858 + approver: &866 type: object properties: avatar_url: @@ -132152,11 +131665,11 @@ x-webhooks: type: string comment: type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - reviewers: &859 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + reviewers: &867 type: array items: type: object @@ -132235,7 +131748,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &860 + workflow_job_run: &868 type: object properties: conclusion: @@ -132966,18 +132479,18 @@ x-webhooks: type: string enum: - rejected - approver: *858 + approver: *866 comment: type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - reviewers: *859 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + reviewers: *867 sender: *4 since: type: string - workflow_job_run: *860 + workflow_job_run: *868 workflow_job_runs: type: array items: @@ -133681,13 +133194,13 @@ x-webhooks: type: string enum: - requested - enterprise: *844 + enterprise: *852 environment: type: string - installation: *845 - organization: *846 - repository: *847 - requestor: &871 + installation: *853 + organization: *854 + repository: *855 + requestor: &879 title: User type: object nullable: true @@ -135586,12 +135099,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - workflow: *861 + workflow: *869 workflow_run: title: Deployment Workflow Run type: object @@ -136271,7 +135784,7 @@ x-webhooks: type: string enum: - answered - answer: &864 + answer: &872 type: object properties: author_association: @@ -136428,7 +135941,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &862 + discussion: &870 title: Discussion description: A Discussion in a repository. type: object @@ -136714,7 +136227,7 @@ x-webhooks: - id labels: type: array - items: *657 + items: *659 required: - repository_url - category @@ -136736,10 +136249,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -136866,11 +136379,11 @@ x-webhooks: - from required: - category - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -136953,11 +136466,11 @@ x-webhooks: type: string enum: - closed - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -137039,7 +136552,7 @@ x-webhooks: type: string enum: - created - comment: &863 + comment: &871 type: object properties: author_association: @@ -137196,11 +136709,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -137283,12 +136796,12 @@ x-webhooks: type: string enum: - deleted - comment: *863 - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + comment: *871 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -137383,12 +136896,12 @@ x-webhooks: - from required: - body - comment: *863 - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + comment: *871 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -137472,11 +136985,11 @@ x-webhooks: type: string enum: - created - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -137558,11 +137071,11 @@ x-webhooks: type: string enum: - deleted - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -137662,11 +137175,11 @@ x-webhooks: type: string required: - from - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -137748,10 +137261,10 @@ x-webhooks: type: string enum: - labeled - discussion: *862 - enterprise: *844 - installation: *845 - label: &865 + discussion: *870 + enterprise: *852 + installation: *853 + label: &873 title: Label type: object properties: @@ -137783,8 +137296,8 @@ x-webhooks: - color - default - description - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -137867,11 +137380,11 @@ x-webhooks: type: string enum: - locked - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -137953,11 +137466,11 @@ x-webhooks: type: string enum: - pinned - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -138039,11 +137552,11 @@ x-webhooks: type: string enum: - reopened - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -138128,16 +137641,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *862 - new_repository: *847 + new_discussion: *870 + new_repository: *855 required: - new_discussion - new_repository - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -138220,10 +137733,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *862 - old_answer: *864 - organization: *846 - repository: *847 + discussion: *870 + old_answer: *872 + organization: *854 + repository: *855 sender: *4 required: - action @@ -138305,12 +137818,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *862 - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -138393,11 +137906,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -138479,11 +137992,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -138552,7 +138065,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *874 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138615,7 +138128,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138681,7 +138194,7 @@ x-webhooks: required: true content: application/json: - schema: *868 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138747,7 +138260,7 @@ x-webhooks: required: true content: application/json: - schema: *869 + schema: *877 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138813,7 +138326,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *874 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138879,7 +138392,7 @@ x-webhooks: required: true content: application/json: - schema: *870 + schema: *878 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138945,7 +138458,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139010,7 +138523,7 @@ x-webhooks: required: true content: application/json: - schema: *868 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139075,7 +138588,7 @@ x-webhooks: required: true content: application/json: - schema: *869 + schema: *877 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139140,7 +138653,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *874 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139205,7 +138718,7 @@ x-webhooks: required: true content: application/json: - schema: *870 + schema: *878 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139271,7 +138784,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139338,7 +138851,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *844 + enterprise: *852 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -139998,9 +139511,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *845 - organization: *846 - repository: *847 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - forkee @@ -140146,9 +139659,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 pages: description: The pages that were updated. type: array @@ -140185,7 +139698,7 @@ x-webhooks: - action - sha - html_url - repository: *847 + repository: *855 sender: *4 required: - pages @@ -140261,10 +139774,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 + enterprise: *852 installation: *22 - organization: *846 - repositories: &872 + organization: *854 + repositories: &880 description: An array of repository objects that the installation can access. type: array @@ -140290,8 +139803,8 @@ x-webhooks: - name - full_name - private - repository: *847 - requester: *871 + repository: *855 + requester: *879 sender: *4 required: - action @@ -140366,11 +139879,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 + enterprise: *852 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *854 + repositories: *880 + repository: *855 requester: nullable: true sender: *4 @@ -140446,11 +139959,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *844 + enterprise: *852 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *854 + repositories: *880 + repository: *855 requester: nullable: true sender: *4 @@ -140526,10 +140039,10 @@ x-webhooks: type: string enum: - added - enterprise: *844 + enterprise: *852 installation: *22 - organization: *846 - repositories_added: &873 + organization: *854 + repositories_added: &881 description: An array of repository objects, which were added to the installation. type: array @@ -140575,15 +140088,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *847 - repository_selection: &874 + repository: *855 + repository_selection: &882 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *871 + requester: *879 sender: *4 required: - action @@ -140662,10 +140175,10 @@ x-webhooks: type: string enum: - removed - enterprise: *844 + enterprise: *852 installation: *22 - organization: *846 - repositories_added: *873 + organization: *854 + repositories_added: *881 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -140692,9 +140205,9 @@ x-webhooks: - name - full_name - private - repository: *847 - repository_selection: *874 - requester: *871 + repository: *855 + repository_selection: *882 + requester: *879 sender: *4 required: - action @@ -140773,11 +140286,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *844 + enterprise: *852 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *854 + repositories: *880 + repository: *855 requester: nullable: true sender: *4 @@ -140956,10 +140469,10 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 target_type: type: string @@ -141038,11 +140551,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *844 + enterprise: *852 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *854 + repositories: *880 + repository: *855 requester: nullable: true sender: *4 @@ -141166,8 +140679,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 reactions: title: Reactions type: object @@ -141294,8 +140807,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -142089,8 +141602,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142106,7 +141619,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -142439,8 +141952,8 @@ x-webhooks: - state - locked - assignee - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -142520,7 +142033,7 @@ x-webhooks: type: string enum: - deleted - comment: &875 + comment: &883 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -142685,8 +142198,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -143476,8 +142989,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143493,7 +143006,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -143828,8 +143341,8 @@ x-webhooks: - state - locked - assignee - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -143909,7 +143422,7 @@ x-webhooks: type: string enum: - edited - changes: &904 + changes: &912 description: The changes to the comment. type: object properties: @@ -143921,9 +143434,9 @@ x-webhooks: type: string required: - from - comment: *875 - enterprise: *844 - installation: *845 + comment: *883 + enterprise: *852 + installation: *853 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -144716,8 +144229,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144733,7 +144246,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -145066,8 +144579,8 @@ x-webhooks: - state - locked - assignee - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145151,15 +144664,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *227 + blocked_issue: *232 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *227 - blocking_issue_repo: *74 - installation: *845 - organization: *846 - repository: *847 + blocking_issue: *232 + blocking_issue_repo: *78 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145247,15 +144760,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *227 + blocked_issue: *232 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *227 - blocking_issue_repo: *74 - installation: *845 - organization: *846 - repository: *847 + blocking_issue: *232 + blocking_issue_repo: *78 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145342,15 +144855,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *227 - blocked_issue_repo: *74 + blocked_issue: *232 + blocked_issue_repo: *78 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *227 - installation: *845 - organization: *846 - repository: *847 + blocking_issue: *232 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145438,15 +144951,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *227 - blocked_issue_repo: *74 + blocked_issue: *232 + blocked_issue_repo: *78 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *227 - installation: *845 - organization: *846 - repository: *847 + blocking_issue: *232 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145531,10 +145044,10 @@ x-webhooks: type: string enum: - assigned - assignee: *871 - enterprise: *844 - installation: *845 - issue: &878 + assignee: *879 + enterprise: *852 + installation: *853 + issue: &886 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -146323,11 +145836,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146343,7 +145856,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -146444,8 +145957,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -146525,8 +146038,8 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -147320,11 +146833,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147340,7 +146853,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -147576,8 +147089,8 @@ x-webhooks: required: - state - closed_at - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -147656,8 +147169,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -148442,11 +147955,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148462,7 +147975,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -148562,8 +148075,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -148642,8 +148155,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -149450,11 +148963,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149470,7 +148983,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -149549,7 +149062,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &876 + milestone: &884 title: Milestone description: A collection of related issues and pull requests. type: object @@ -149687,8 +149200,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -149787,8 +149300,8 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -150577,11 +150090,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150594,7 +150107,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *360 + type: *367 title: description: Title of the issue type: string @@ -150698,9 +150211,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *865 - organization: *846 - repository: *847 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -150780,8 +150293,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -151569,11 +151082,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151586,7 +151099,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *360 + type: *367 title: description: Title of the issue type: string @@ -151690,9 +151203,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *865 - organization: *846 - repository: *847 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -151772,8 +151285,8 @@ x-webhooks: type: string enum: - locked - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -152585,11 +152098,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152602,7 +152115,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *360 + type: *367 title: description: Title of the issue type: string @@ -152683,8 +152196,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -152763,8 +152276,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -153570,11 +153083,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153590,7 +153103,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -153668,9 +153181,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *876 - organization: *846 - repository: *847 + milestone: *884 + organization: *854 + repository: *855 sender: *4 required: - action @@ -154538,11 +154051,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154635,7 +154148,7 @@ x-webhooks: required: - login - id - type: *360 + type: *367 required: - id - number @@ -155104,8 +154617,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -155894,11 +155407,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155914,7 +155427,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -156014,8 +155527,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -156095,9 +155608,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *844 - installation: *845 - issue: &877 + enterprise: *852 + installation: *853 + issue: &885 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -156880,11 +156393,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156900,7 +156413,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -157000,8 +156513,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -157080,8 +156593,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -157891,11 +157404,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157989,9 +157502,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *360 - organization: *846 - repository: *847 + type: *367 + organization: *854 + repository: *855 sender: *4 required: - action @@ -158857,11 +158370,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -158877,7 +158390,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -159445,11 +158958,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *844 - installation: *845 - issue: *877 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + issue: *885 + organization: *854 + repository: *855 sender: *4 required: - action @@ -159529,12 +159042,12 @@ x-webhooks: type: string enum: - typed - enterprise: *844 - installation: *845 - issue: *878 - type: *360 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + issue: *886 + type: *367 + organization: *854 + repository: *855 sender: *4 required: - action @@ -159615,7 +159128,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &907 + assignee: &915 title: User type: object nullable: true @@ -159685,11 +159198,11 @@ x-webhooks: required: - login - id - enterprise: *844 - installation: *845 - issue: *878 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + issue: *886 + organization: *854 + repository: *855 sender: *4 required: - action @@ -159768,12 +159281,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *844 - installation: *845 - issue: *878 - label: *865 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + issue: *886 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -159853,8 +159366,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -160664,11 +160177,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160684,7 +160197,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -160762,8 +160275,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -160843,11 +160356,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *844 - installation: *845 - issue: *877 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + issue: *885 + organization: *854 + repository: *855 sender: *4 required: - action @@ -160926,12 +160439,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *844 - installation: *845 - issue: *878 - type: *360 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + issue: *886 + type: *367 + organization: *854 + repository: *855 sender: *4 required: - action @@ -161011,11 +160524,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -161093,11 +160606,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -161207,11 +160720,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -161293,9 +160806,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: &879 + enterprise: *852 + installation: *853 + marketplace_purchase: &887 title: Marketplace Purchase type: object required: @@ -161378,8 +160891,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *846 - previous_marketplace_purchase: &880 + organization: *854 + previous_marketplace_purchase: &888 title: Marketplace Purchase type: object properties: @@ -161459,7 +160972,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *847 + repository: *855 sender: *4 required: - action @@ -161539,10 +161052,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: *879 - organization: *846 + enterprise: *852 + installation: *853 + marketplace_purchase: *887 + organization: *854 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -161625,7 +161138,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *847 + repository: *855 sender: *4 required: - action @@ -161707,10 +161220,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: *879 - organization: *846 + enterprise: *852 + installation: *853 + marketplace_purchase: *887 + organization: *854 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -161792,7 +161305,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *847 + repository: *855 sender: *4 required: - action @@ -161873,8 +161386,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 marketplace_purchase: title: Marketplace Purchase type: object @@ -161956,9 +161469,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *846 - previous_marketplace_purchase: *880 - repository: *847 + organization: *854 + previous_marketplace_purchase: *888 + repository: *855 sender: *4 required: - action @@ -162038,12 +161551,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: *879 - organization: *846 - previous_marketplace_purchase: *880 - repository: *847 + enterprise: *852 + installation: *853 + marketplace_purchase: *887 + organization: *854 + previous_marketplace_purchase: *888 + repository: *855 sender: *4 required: - action @@ -162145,11 +161658,11 @@ x-webhooks: type: string required: - to - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + member: *879 + organization: *854 + repository: *855 sender: *4 required: - action @@ -162249,11 +161762,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + member: *879 + organization: *854 + repository: *855 sender: *4 required: - action @@ -162332,11 +161845,11 @@ x-webhooks: type: string enum: - removed - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + member: *879 + organization: *854 + repository: *855 sender: *4 required: - action @@ -162414,11 +161927,11 @@ x-webhooks: type: string enum: - added - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + member: *879 + organization: *854 + repository: *855 scope: description: The scope of the membership. Currently, can only be `team`. @@ -162494,7 +162007,7 @@ x-webhooks: required: - login - id - team: &881 + team: &889 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -162717,11 +162230,11 @@ x-webhooks: type: string enum: - removed - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + member: *879 + organization: *854 + repository: *855 scope: description: The scope of the membership. Currently, can only be `team`. @@ -162798,7 +162311,7 @@ x-webhooks: required: - login - id - team: *881 + team: *889 required: - action - scope @@ -162880,8 +162393,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *845 - merge_group: &883 + installation: *853 + merge_group: &891 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -162900,15 +162413,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *882 + head_commit: *890 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -162994,10 +162507,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *845 - merge_group: *883 - organization: *846 - repository: *847 + installation: *853 + merge_group: *891 + organization: *854 + repository: *855 sender: *4 required: - action @@ -163070,7 +162583,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 + enterprise: *852 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -163179,16 +162692,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *845 - organization: *846 + installation: *853 + organization: *854 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *892 + required: *893 nullable: true sender: *4 required: @@ -163269,11 +162782,11 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 - milestone: *876 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + milestone: *884 + organization: *854 + repository: *855 sender: *4 required: - action @@ -163352,9 +162865,9 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - milestone: &886 + enterprise: *852 + installation: *853 + milestone: &894 title: Milestone description: A collection of related issues and pull requests. type: object @@ -163491,8 +163004,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -163571,11 +163084,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - milestone: *876 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + milestone: *884 + organization: *854 + repository: *855 sender: *4 required: - action @@ -163685,11 +163198,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - milestone: *876 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + milestone: *884 + organization: *854 + repository: *855 sender: *4 required: - action @@ -163769,11 +163282,11 @@ x-webhooks: type: string enum: - opened - enterprise: *844 - installation: *845 - milestone: *886 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + milestone: *894 + organization: *854 + repository: *855 sender: *4 required: - action @@ -163852,11 +163365,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *871 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + blocked_user: *879 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -163935,11 +163448,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *871 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + blocked_user: *879 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -164014,8 +163527,8 @@ x-webhooks: type: string enum: - created - definition: *146 - enterprise: *844 + definition: *150 + enterprise: *852 sender: *4 required: - action @@ -164095,8 +163608,8 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 sender: *4 required: - action @@ -164168,9 +163681,9 @@ x-webhooks: type: string enum: - updated - definition: *146 - enterprise: *844 - installation: *845 + definition: *150 + enterprise: *852 + installation: *853 sender: *4 required: - action @@ -164242,18 +163755,18 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 sender: *4 new_property_values: type: array description: The new custom property values. - items: *151 + items: *155 old_property_values: type: array description: The old custom property values. - items: *151 + items: *155 required: - action - organization @@ -164332,9 +163845,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - membership: &887 + enterprise: *852 + installation: *853 + membership: &895 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -164441,8 +163954,8 @@ x-webhooks: - role - organization_url - user - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -164520,11 +164033,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *844 - installation: *845 - membership: *887 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + membership: *895 + organization: *854 + repository: *855 sender: *4 required: - action @@ -164603,8 +164116,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -164720,10 +164233,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 - user: *871 + user: *879 required: - action - invitation @@ -164801,11 +164314,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *844 - installation: *845 - membership: *887 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + membership: *895 + organization: *854 + repository: *855 sender: *4 required: - action @@ -164892,11 +164405,11 @@ x-webhooks: properties: from: type: string - enterprise: *844 - installation: *845 - membership: *887 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + membership: *895 + organization: *854 + repository: *855 sender: *4 required: - action @@ -164972,9 +164485,9 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 package: description: Information about the package. type: object @@ -165473,7 +164986,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &888 + items: &896 title: Ruby Gems metadata type: object properties: @@ -165568,7 +165081,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *855 sender: *4 required: - action @@ -165644,9 +165157,9 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 package: description: Information about the package. type: object @@ -165999,7 +165512,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *888 + items: *896 source_url: type: string format: uri @@ -166069,7 +165582,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *855 sender: *4 required: - action @@ -166246,12 +165759,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *844 + enterprise: *852 id: type: integer - installation: *845 - organization: *846 - repository: *847 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - id @@ -166328,7 +165841,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &889 + personal_access_token_request: &897 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -166474,10 +165987,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *844 - organization: *846 + enterprise: *852 + organization: *854 sender: *4 - installation: *845 + installation: *853 required: - action - personal_access_token_request @@ -166554,11 +166067,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *889 - enterprise: *844 - organization: *846 + personal_access_token_request: *897 + enterprise: *852 + organization: *854 sender: *4 - installation: *845 + installation: *853 required: - action - personal_access_token_request @@ -166634,11 +166147,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *889 - enterprise: *844 - organization: *846 + personal_access_token_request: *897 + enterprise: *852 + organization: *854 sender: *4 - installation: *845 + installation: *853 required: - action - personal_access_token_request @@ -166713,11 +166226,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *889 - organization: *846 - enterprise: *844 + personal_access_token_request: *897 + organization: *854 + enterprise: *852 sender: *4 - installation: *845 + installation: *853 required: - action - personal_access_token_request @@ -166822,7 +166335,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *890 + last_response: *898 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -166854,8 +166367,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 zen: description: Random string of GitHub zen. @@ -167100,10 +166613,10 @@ x-webhooks: - from required: - note - enterprise: *844 - installation: *845 - organization: *846 - project_card: &891 + enterprise: *852 + installation: *853 + organization: *854 + project_card: &899 title: Project Card type: object properties: @@ -167222,7 +166735,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *847 + repository: *855 sender: *4 required: - action @@ -167303,11 +166816,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - project_card: *891 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + project_card: *899 + repository: *855 sender: *4 required: - action @@ -167387,9 +166900,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 project_card: title: Project Card type: object @@ -167517,8 +167030,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *892 + required: *893 nullable: true sender: *4 required: @@ -167612,11 +167125,11 @@ x-webhooks: - from required: - note - enterprise: *844 - installation: *845 - organization: *846 - project_card: *891 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + project_card: *899 + repository: *855 sender: *4 required: - action @@ -167710,9 +167223,9 @@ x-webhooks: - from required: - column_id - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 project_card: allOf: - title: Project Card @@ -167902,7 +167415,7 @@ x-webhooks: type: string required: - after_id - repository: *847 + repository: *855 sender: *4 required: - action @@ -167982,10 +167495,10 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 - organization: *846 - project: &893 + enterprise: *852 + installation: *853 + organization: *854 + project: &901 title: Project type: object properties: @@ -168109,7 +167622,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *847 + repository: *855 sender: *4 required: - action @@ -168189,10 +167702,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - project_column: &892 + enterprise: *852 + installation: *853 + organization: *854 + project_column: &900 title: Project Column type: object properties: @@ -168231,7 +167744,7 @@ x-webhooks: - name - created_at - updated_at - repository: *847 + repository: *855 sender: *4 required: - action @@ -168310,18 +167823,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - project_column: *892 + enterprise: *852 + installation: *853 + organization: *854 + project_column: *900 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *892 + required: *893 nullable: true sender: *4 required: @@ -168411,11 +167924,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - project_column: *892 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + project_column: *900 + repository: *855 sender: *4 required: - action @@ -168495,11 +168008,11 @@ x-webhooks: type: string enum: - moved - enterprise: *844 - installation: *845 - organization: *846 - project_column: *892 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + project_column: *900 + repository: *855 sender: *4 required: - action @@ -168579,11 +168092,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - project: *893 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + project: *901 + repository: *855 sender: *4 required: - action @@ -168663,18 +168176,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - project: *893 + enterprise: *852 + installation: *853 + organization: *854 + project: *901 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *892 + required: *893 nullable: true sender: *4 required: @@ -168776,11 +168289,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - project: *893 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + project: *901 + repository: *855 sender: *4 required: - action @@ -168859,11 +168372,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *844 - installation: *845 - organization: *846 - project: *893 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + project: *901 + repository: *855 sender: *4 required: - action @@ -168944,9 +168457,9 @@ x-webhooks: type: string enum: - closed - installation: *845 - organization: *846 - projects_v2: *392 + installation: *853 + organization: *854 + projects_v2: *399 sender: *4 required: - action @@ -169027,9 +168540,9 @@ x-webhooks: type: string enum: - created - installation: *845 - organization: *846 - projects_v2: *392 + installation: *853 + organization: *854 + projects_v2: *399 sender: *4 required: - action @@ -169110,9 +168623,9 @@ x-webhooks: type: string enum: - deleted - installation: *845 - organization: *846 - projects_v2: *392 + installation: *853 + organization: *854 + projects_v2: *399 sender: *4 required: - action @@ -169229,9 +168742,9 @@ x-webhooks: type: string to: type: string - installation: *845 - organization: *846 - projects_v2: *392 + installation: *853 + organization: *854 + projects_v2: *399 sender: *4 required: - action @@ -169314,7 +168827,7 @@ x-webhooks: type: string enum: - archived - changes: &897 + changes: &905 type: object properties: archived_at: @@ -169328,9 +168841,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *845 - organization: *846 - projects_v2_item: &894 + installation: *853 + organization: *854 + projects_v2_item: &902 title: Projects v2 Item description: An item belonging to a project type: object @@ -169348,7 +168861,7 @@ x-webhooks: type: string description: The node ID of the content represented by this item. - content_type: *399 + content_type: *406 creator: *4 created_at: type: string @@ -169465,9 +168978,9 @@ x-webhooks: nullable: true to: type: string - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *853 + organization: *854 + projects_v2_item: *902 sender: *4 required: - action @@ -169549,9 +169062,9 @@ x-webhooks: type: string enum: - created - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *853 + organization: *854 + projects_v2_item: *902 sender: *4 required: - action @@ -169632,9 +169145,9 @@ x-webhooks: type: string enum: - deleted - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *853 + organization: *854 + projects_v2_item: *902 sender: *4 required: - action @@ -169740,7 +169253,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &895 + - &903 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -169762,7 +169275,7 @@ x-webhooks: required: - id - name - - &896 + - &904 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -169796,8 +169309,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *895 - - *896 + - *903 + - *904 required: - field_value - type: object @@ -169813,9 +169326,9 @@ x-webhooks: nullable: true required: - body - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *853 + organization: *854 + projects_v2_item: *902 sender: *4 required: - action @@ -169910,9 +169423,9 @@ x-webhooks: to: type: string nullable: true - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *853 + organization: *854 + projects_v2_item: *902 sender: *4 required: - action @@ -169995,10 +169508,10 @@ x-webhooks: type: string enum: - restored - changes: *897 - installation: *845 - organization: *846 - projects_v2_item: *894 + changes: *905 + installation: *853 + organization: *854 + projects_v2_item: *902 sender: *4 required: - action @@ -170080,9 +169593,9 @@ x-webhooks: type: string enum: - reopened - installation: *845 - organization: *846 - projects_v2: *392 + installation: *853 + organization: *854 + projects_v2: *399 sender: *4 required: - action @@ -170163,14 +169676,14 @@ x-webhooks: type: string enum: - created - installation: *845 - organization: *846 - projects_v2_status_update: &900 + installation: *853 + organization: *854 + projects_v2_status_update: &908 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *898 - required: *899 + properties: *906 + required: *907 sender: *4 required: - action @@ -170251,9 +169764,9 @@ x-webhooks: type: string enum: - deleted - installation: *845 - organization: *846 - projects_v2_status_update: *900 + installation: *853 + organization: *854 + projects_v2_status_update: *908 sender: *4 required: - action @@ -170389,9 +169902,9 @@ x-webhooks: type: string format: date nullable: true - installation: *845 - organization: *846 - projects_v2_status_update: *900 + installation: *853 + organization: *854 + projects_v2_status_update: *908 sender: *4 required: - action @@ -170462,10 +169975,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - repository @@ -170542,13 +170055,13 @@ x-webhooks: type: string enum: - assigned - assignee: *871 - enterprise: *844 - installation: *845 - number: &901 + assignee: *879 + enterprise: *852 + installation: *853 + number: &909 description: The pull request number. type: integer - organization: *846 + organization: *854 pull_request: title: Pull Request type: object @@ -172831,7 +172344,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 sender: *4 required: - action @@ -172913,11 +172426,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 number: type: integer - organization: *846 + organization: *854 pull_request: title: Pull Request type: object @@ -175195,7 +174708,7 @@ x-webhooks: - draft reason: type: string - repository: *847 + repository: *855 sender: *4 required: - action @@ -175277,11 +174790,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 number: type: integer - organization: *846 + organization: *854 pull_request: title: Pull Request type: object @@ -177559,7 +177072,7 @@ x-webhooks: - draft reason: type: string - repository: *847 + repository: *855 sender: *4 required: - action @@ -177641,13 +177154,13 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: &902 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 + pull_request: &910 allOf: - - *695 + - *697 - type: object properties: allow_auto_merge: @@ -177709,7 +177222,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *847 + repository: *855 sender: *4 required: - action @@ -177790,12 +177303,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 + pull_request: *910 + repository: *855 sender: *4 required: - action @@ -177875,11 +177388,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *844 - milestone: *677 - number: *901 - organization: *846 - pull_request: &903 + enterprise: *852 + milestone: *679 + number: *909 + organization: *854 + pull_request: &911 title: Pull Request type: object properties: @@ -180142,7 +179655,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 sender: *4 required: - action @@ -180221,11 +179734,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 number: type: integer - organization: *846 + organization: *854 pull_request: title: Pull Request type: object @@ -182507,7 +182020,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *847 + repository: *855 sender: *4 required: - action @@ -182631,12 +182144,12 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 + pull_request: *910 + repository: *855 sender: *4 required: - action @@ -182716,11 +182229,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 number: type: integer - organization: *846 + organization: *854 pull_request: title: Pull Request type: object @@ -184987,7 +184500,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 sender: *4 required: - action @@ -185067,11 +184580,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *844 - installation: *845 - label: *865 - number: *901 - organization: *846 + enterprise: *852 + installation: *853 + label: *873 + number: *909 + organization: *854 pull_request: title: Pull Request type: object @@ -187353,7 +186866,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 sender: *4 required: - action @@ -187434,10 +186947,10 @@ x-webhooks: type: string enum: - locked - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 pull_request: title: Pull Request type: object @@ -189717,7 +189230,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 sender: *4 required: - action @@ -189797,12 +189310,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *844 - milestone: *677 - number: *901 - organization: *846 - pull_request: *903 - repository: *847 + enterprise: *852 + milestone: *679 + number: *909 + organization: *854 + pull_request: *911 + repository: *855 sender: *4 required: - action @@ -189881,12 +189394,12 @@ x-webhooks: type: string enum: - opened - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 + pull_request: *910 + repository: *855 sender: *4 required: - action @@ -189967,12 +189480,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 + pull_request: *910 + repository: *855 sender: *4 required: - action @@ -190052,12 +189565,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 + pull_request: *910 + repository: *855 sender: *4 required: - action @@ -190423,9 +189936,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 pull_request: type: object properties: @@ -192595,7 +192108,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *847 + repository: *855 sender: *4 required: - action @@ -192675,7 +192188,7 @@ x-webhooks: type: string enum: - deleted - comment: &905 + comment: &913 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -192960,9 +192473,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 pull_request: type: object properties: @@ -195120,7 +194633,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *847 + repository: *855 sender: *4 required: - action @@ -195200,11 +194713,11 @@ x-webhooks: type: string enum: - edited - changes: *904 - comment: *905 - enterprise: *844 - installation: *845 - organization: *846 + changes: *912 + comment: *913 + enterprise: *852 + installation: *853 + organization: *854 pull_request: type: object properties: @@ -197365,7 +196878,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *847 + repository: *855 sender: *4 required: - action @@ -197446,9 +196959,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 pull_request: title: Simple Pull Request type: object @@ -199621,7 +199134,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 + repository: *855 review: description: The review that was affected. type: object @@ -199868,9 +199381,9 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 pull_request: title: Simple Pull Request type: object @@ -201924,8 +201437,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 - review: &906 + repository: *855 + review: &914 description: The review that was affected. type: object properties: @@ -202158,12 +201671,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 number: description: The pull request number. type: integer - organization: *846 + organization: *854 pull_request: title: Pull Request type: object @@ -204446,7 +203959,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 requested_reviewer: title: User type: object @@ -204530,12 +204043,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 number: description: The pull request number. type: integer - organization: *846 + organization: *854 pull_request: title: Pull Request type: object @@ -206825,7 +206338,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 requested_team: title: Team description: Groups of organization members that gives permissions @@ -207017,12 +206530,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 number: description: The pull request number. type: integer - organization: *846 + organization: *854 pull_request: title: Pull Request type: object @@ -209307,7 +208820,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 requested_reviewer: title: User type: object @@ -209392,12 +208905,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 number: description: The pull request number. type: integer - organization: *846 + organization: *854 pull_request: title: Pull Request type: object @@ -211673,7 +211186,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 requested_team: title: Team description: Groups of organization members that gives permissions @@ -211854,9 +211367,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 pull_request: title: Simple Pull Request type: object @@ -214031,8 +213544,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 - review: *906 + repository: *855 + review: *914 sender: *4 required: - action @@ -214112,9 +213625,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 pull_request: title: Simple Pull Request type: object @@ -216184,7 +215697,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 + repository: *855 sender: *4 thread: type: object @@ -216571,9 +216084,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 pull_request: title: Simple Pull Request type: object @@ -218629,7 +218142,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 + repository: *855 sender: *4 thread: type: object @@ -219019,10 +218532,10 @@ x-webhooks: type: string before: type: string - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 pull_request: title: Pull Request type: object @@ -221293,7 +220806,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 sender: *4 required: - action @@ -221375,11 +220888,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *907 - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + assignee: *915 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 pull_request: title: Pull Request type: object @@ -223662,7 +223175,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 sender: *4 required: - action @@ -223741,11 +223254,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *844 - installation: *845 - label: *865 - number: *901 - organization: *846 + enterprise: *852 + installation: *853 + label: *873 + number: *909 + organization: *854 pull_request: title: Pull Request type: object @@ -226018,7 +225531,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 sender: *4 required: - action @@ -226099,10 +225612,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 pull_request: title: Pull Request type: object @@ -228367,7 +227880,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 sender: *4 required: - action @@ -228567,7 +228080,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *844 + enterprise: *852 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -228659,8 +228172,8 @@ x-webhooks: - url - author - committer - installation: *845 - organization: *846 + installation: *853 + organization: *854 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -229235,9 +228748,9 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 registry_package: type: object properties: @@ -229683,7 +229196,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *888 + items: *896 summary: type: string tag_name: @@ -229737,7 +229250,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *855 sender: *4 required: - action @@ -229815,9 +229328,9 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 registry_package: type: object properties: @@ -230125,7 +229638,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *888 + items: *896 summary: type: string tag_name: @@ -230174,7 +229687,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *855 sender: *4 required: - action @@ -230251,10 +229764,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - release: &908 + enterprise: *852 + installation: *853 + organization: *854 + release: &916 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -230572,7 +230085,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *847 + repository: *855 sender: *4 required: - action @@ -230649,11 +230162,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - release: *908 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + release: *916 + repository: *855 sender: *4 required: - action @@ -230770,11 +230283,11 @@ x-webhooks: type: boolean required: - to - enterprise: *844 - installation: *845 - organization: *846 - release: *908 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + release: *916 + repository: *855 sender: *4 required: - action @@ -230852,9 +230365,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -231176,7 +230689,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *847 + repository: *855 sender: *4 required: - action @@ -231252,10 +230765,10 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 - release: &909 + enterprise: *852 + installation: *853 + organization: *854 + release: &917 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -231574,7 +231087,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *847 + repository: *855 sender: *4 required: - action @@ -231650,11 +231163,11 @@ x-webhooks: type: string enum: - released - enterprise: *844 - installation: *845 - organization: *846 - release: *908 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + release: *916 + repository: *855 sender: *4 required: - action @@ -231730,11 +231243,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *844 - installation: *845 - organization: *846 - release: *909 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + release: *917 + repository: *855 sender: *4 required: - action @@ -231810,11 +231323,11 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - repository_advisory: *748 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + repository_advisory: *749 sender: *4 required: - action @@ -231890,11 +231403,11 @@ x-webhooks: type: string enum: - reported - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - repository_advisory: *748 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + repository_advisory: *749 sender: *4 required: - action @@ -231970,10 +231483,10 @@ x-webhooks: type: string enum: - archived - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -232050,10 +231563,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -232131,10 +231644,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -232218,10 +231731,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -232333,10 +231846,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -232408,10 +231921,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 status: type: string @@ -232492,10 +232005,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -232572,10 +232085,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -232669,10 +232182,10 @@ x-webhooks: - name required: - repository - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -232752,11 +232265,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - repository_ruleset: *185 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + repository_ruleset: *190 sender: *4 required: - action @@ -232834,11 +232347,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - repository_ruleset: *185 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + repository_ruleset: *190 sender: *4 required: - action @@ -232916,11 +232429,11 @@ x-webhooks: type: string enum: - edited - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - repository_ruleset: *185 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + repository_ruleset: *190 changes: type: object properties: @@ -232939,16 +232452,16 @@ x-webhooks: properties: added: type: array - items: *157 + items: *161 deleted: type: array - items: *157 + items: *161 updated: type: array items: type: object properties: - condition: *157 + condition: *161 changes: type: object properties: @@ -232981,16 +232494,16 @@ x-webhooks: properties: added: type: array - items: *716 + items: *717 deleted: type: array - items: *716 + items: *717 updated: type: array items: type: object properties: - rule: *716 + rule: *717 changes: type: object properties: @@ -233224,10 +232737,10 @@ x-webhooks: - from required: - owner - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -233305,10 +232818,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -233386,7 +232899,7 @@ x-webhooks: type: string enum: - create - alert: &910 + alert: &918 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -233507,10 +233020,10 @@ x-webhooks: type: string enum: - open - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -233716,10 +233229,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -233797,11 +233310,11 @@ x-webhooks: type: string enum: - reopen - alert: *910 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *918 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -234000,10 +233513,10 @@ x-webhooks: enum: - fixed - open - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -234021,7 +233534,7 @@ x-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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. @@ -234029,8 +233542,8 @@ x-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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -234074,18 +233587,18 @@ x-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: &911 + - assigned + alert: &919 type: object properties: - number: *123 - created_at: *130 + number: *127 + created_at: *134 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -234093,8 +233606,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *128 - html_url: *129 + url: *132 + html_url: *133 locations_url: type: string format: uri @@ -234199,10 +233712,93 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + assignee: *4 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + 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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + + 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/enterprise-cloud@latest//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: *919 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -234283,11 +233879,11 @@ x-webhooks: type: string enum: - created - alert: *911 - installation: *845 - location: *912 - organization: *846 - repository: *847 + alert: *919 + installation: *853 + location: *920 + organization: *854 + repository: *855 sender: *4 required: - location @@ -234525,11 +234121,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *919 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -234607,11 +234203,11 @@ x-webhooks: type: string enum: - reopened - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *919 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -234689,11 +234285,94 @@ x-webhooks: type: string enum: - resolved - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *919 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + 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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + + 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/enterprise-cloud@latest//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: *919 + assignee: *4 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -234771,11 +234450,11 @@ x-webhooks: type: string enum: - validated - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *919 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -234901,10 +234580,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *847 - enterprise: *844 - installation: *845 - organization: *846 + repository: *855 + enterprise: *852 + installation: *853 + organization: *854 sender: *4 required: - action @@ -234982,11 +234661,11 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - security_advisory: &913 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + security_advisory: &921 description: The details of the security advisory, including summary, description, and severity. type: object @@ -235002,7 +234681,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *125 + cvss_severities: *129 cwes: type: array items: @@ -235169,11 +234848,11 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - security_advisory: *913 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + security_advisory: *921 sender: *4 required: - action @@ -235246,10 +234925,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -235266,7 +234945,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *125 + cvss_severities: *129 cwes: type: array items: @@ -235433,10 +235112,10 @@ x-webhooks: from: type: object properties: - security_and_analysis: *408 - enterprise: *844 - installation: *845 - organization: *846 + security_and_analysis: *415 + enterprise: *852 + installation: *853 + organization: *854 repository: *467 sender: *4 required: @@ -235515,12 +235194,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - sponsorship: &914 + sponsorship: &922 type: object properties: created_at: @@ -235821,12 +235500,12 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - sponsorship: *914 + sponsorship: *922 required: - action - sponsorship @@ -235914,12 +235593,12 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - sponsorship: *914 + sponsorship: *922 required: - action - changes @@ -235996,17 +235675,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &915 + effective_date: &923 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: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - sponsorship: *914 + sponsorship: *922 required: - action - sponsorship @@ -236080,7 +235759,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &916 + changes: &924 type: object properties: tier: @@ -236124,13 +235803,13 @@ x-webhooks: - from required: - tier - effective_date: *915 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + effective_date: *923 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - sponsorship: *914 + sponsorship: *922 required: - action - changes @@ -236207,13 +235886,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *916 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + changes: *924 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - sponsorship: *914 + sponsorship: *922 required: - action - changes @@ -236287,10 +235966,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -236373,10 +236052,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -236796,15 +236475,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *844 + enterprise: *852 id: description: The unique identifier of the status. type: integer - installation: *845 + installation: *853 name: type: string - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 sha: description: The Commit SHA. @@ -236913,15 +236592,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *227 - parent_issue_repo: *74 + parent_issue: *232 + parent_issue_repo: *78 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *227 - installation: *845 - organization: *846 - repository: *847 + sub_issue: *232 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -237005,15 +236684,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *227 - parent_issue_repo: *74 + parent_issue: *232 + parent_issue_repo: *78 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *227 - installation: *845 - organization: *846 - repository: *847 + sub_issue: *232 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -237097,15 +236776,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *227 - sub_issue_repo: *74 + sub_issue: *232 + sub_issue_repo: *78 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *227 - installation: *845 - organization: *846 - repository: *847 + parent_issue: *232 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -237189,15 +236868,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *227 - sub_issue_repo: *74 + sub_issue: *232 + sub_issue_repo: *78 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *227 - installation: *845 - organization: *846 - repository: *847 + parent_issue: *232 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -237274,12 +236953,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - team: &917 + team: &925 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -237502,9 +237181,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 repository: title: Repository description: A git repository @@ -237962,7 +237641,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *925 required: - action - team @@ -238038,9 +237717,9 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 repository: title: Repository description: A git repository @@ -238498,7 +238177,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *925 required: - action - team @@ -238575,9 +238254,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 repository: title: Repository description: A git repository @@ -239035,7 +238714,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *925 required: - action - team @@ -239179,9 +238858,9 @@ x-webhooks: - from required: - permissions - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 repository: title: Repository description: A git repository @@ -239639,7 +239318,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *925 required: - action - changes @@ -239717,9 +239396,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 repository: title: Repository description: A git repository @@ -240177,7 +239856,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *925 required: - action - team @@ -240253,10 +239932,10 @@ x-webhooks: type: string enum: - started - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -240329,16 +240008,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *844 + enterprise: *852 inputs: type: object nullable: true additionalProperties: true - installation: *845 - organization: *846 + installation: *853 + organization: *854 ref: type: string - repository: *847 + repository: *855 sender: *4 workflow: type: string @@ -240420,10 +240099,10 @@ x-webhooks: type: string enum: - completed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 workflow_job: allOf: @@ -240660,7 +240339,7 @@ x-webhooks: type: string required: - conclusion - deployment: *599 + deployment: *601 required: - action - repository @@ -240739,10 +240418,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 workflow_job: allOf: @@ -241002,7 +240681,7 @@ x-webhooks: required: - status - steps - deployment: *599 + deployment: *601 required: - action - repository @@ -241081,10 +240760,10 @@ x-webhooks: type: string enum: - queued - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 workflow_job: type: object @@ -241219,7 +240898,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *599 + deployment: *601 required: - action - repository @@ -241298,10 +240977,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 workflow_job: type: object @@ -241437,7 +241116,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *599 + deployment: *601 required: - action - repository @@ -241517,12 +241196,12 @@ x-webhooks: type: string enum: - completed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - workflow: *861 + workflow: *869 workflow_run: title: Workflow Run type: object @@ -242521,12 +242200,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - workflow: *861 + workflow: *869 workflow_run: title: Workflow Run type: object @@ -243510,12 +243189,12 @@ x-webhooks: type: string enum: - requested - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - workflow: *861 + workflow: *869 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index cf7f65190..3a847bd24 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.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." @@ -4734,6 +4730,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.", @@ -5735,6 +5739,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.", @@ -6590,6 +6602,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.", @@ -7076,6 +7096,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.", @@ -9117,6 +9145,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.", @@ -10169,6 +10205,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.", @@ -11138,6 +11182,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.", @@ -11818,6 +11870,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.", @@ -17501,6 +17561,572 @@ } } }, + "/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/enterprise-cloud@latest//rest/actions/cache#get-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" + } + } + ], + "responses": { + "200": { + "description": "Response", + "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", + "example": 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 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/enterprise-cloud@latest//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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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/enterprise-cloud@latest//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", + "example": 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/enterprise-cloud@latest//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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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/usage": { "get": { "summary": "Get GitHub Actions cache usage for an enterprise", @@ -27409,6 +28035,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.", @@ -28205,6 +28839,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.", @@ -29157,6 +29799,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.", @@ -30500,6 +31150,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.", @@ -52734,6 +53392,35 @@ ] } } + }, + { + "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." + } + } + } + } } ] } @@ -57356,6 +58043,35 @@ ] } } + }, + { + "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." + } + } + } + } } ] } @@ -59354,6 +60070,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.", @@ -61888,6 +62627,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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": { @@ -61977,6 +62757,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": [ @@ -63078,226 +63862,20 @@ "update-budget": { "value": { "message": "Budget successfully updated.", - "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" - } - } - } - } - } - }, - "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", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "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" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Budget not found or feature not enabled", - "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" - } - } - }, - "examples": { - "budget-not-found": { - "value": { - "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - }, - "feature-not-enabled": { - "value": { - "message": "Not Found", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } + "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" + ] } } } @@ -63306,146 +63884,367 @@ } } }, - "500": { - "description": "Internal server error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - }, - "examples": { - "server-error": { - "value": { - "message": "Unable to retrieve budget.", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "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" - } - } - }, - "examples": { - "server-error": { - "value": { - "message": "Unable to update budget.", - "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "billing", - "subcategory": "budgets" - } - }, - "delete": { - "summary": "Delete a budget", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID. The authenticated user must be an enterprise admin.", - "tags": [ - "billing" - ], - "operationId": "billing/delete-budget", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#delete-a-budget" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "budget_id", - "description": "The ID corresponding to the budget.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response when deleting a budget", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "A message indicating the result of the deletion operation" - }, - "id": { - "type": "string", - "description": "The ID of the deleted budget" - } - }, - "required": [ - "message", - "id" - ] - }, - "examples": { - "default": { - "value": { - "message": "Budget successfully deleted.", - "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" - } - } - } - } - } - }, + "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "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" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Budget not found or feature not enabled", + "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" + } + } + }, + "examples": { + "budget-not-found": { + "value": { + "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + }, + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + } + } + } + } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to retrieve budget.", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "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" + } + } + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to update budget.", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "budgets" + } + }, + "delete": { + "summary": "Delete a budget", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID. The authenticated user must be an enterprise admin.", + "tags": [ + "billing" + ], + "operationId": "billing/delete-budget", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#delete-a-budget" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "budget_id", + "description": "The ID corresponding to the budget.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response when deleting a budget", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the deletion operation" + }, + "id": { + "type": "string", + "description": "The ID of the deleted budget" + } + }, + "required": [ + "message", + "id" + ] + }, + "examples": { + "default": { + "value": { + "message": "Budget successfully deleted.", + "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" + } + } + } + } + } + }, "400": { "description": "Bad Request", "content": { @@ -97479,6 +98278,572 @@ "deprecated": true } }, + "/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/enterprise-cloud@latest//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", + "example": 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/enterprise-cloud@latest//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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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/enterprise-cloud@latest//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", + "example": 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/enterprise-cloud@latest//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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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", @@ -151668,6 +153033,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.", @@ -152684,6 +154057,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.", @@ -188900,19 +190281,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/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#add-a-field-to-an-organization-owned-project" }, "parameters": [ { @@ -188924,15 +190303,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.", @@ -188943,9 +190313,262 @@ } } ], + "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": { @@ -189135,7 +190758,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", @@ -189145,37 +190801,509 @@ "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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/enterprise-cloud@latest//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": { + "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.", + "example": "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", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was last updated." + } + }, + "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": { @@ -211453,6 +213581,35 @@ ] } } + }, + { + "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." + } + } + } + } } ] } @@ -216115,6 +218272,35 @@ ] } } + }, + { + "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." + } + } + } + } } ] } @@ -218162,6 +220348,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.", @@ -235193,17 +237402,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/enterprise-cloud@latest//rest/teams/teams#list-team-projects" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -235251,42 +237460,28 @@ "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", + "example": 1296269 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "type": "string" - }, - "body": { "type": "string", - "nullable": true - }, - "number": { - "type": "integer" + "example": "Hello-World" }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -235410,55 +237605,550 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "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", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "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", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, "permissions": { "type": "object", "properties": { - "read": { + "admin": { + "type": "boolean" + }, + "maintain": { "type": "boolean" }, - "write": { + "push": { "type": "boolean" }, - "admin": { + "triage": { + "type": "boolean" + }, + "pull": { "type": "boolean" } + } + }, + "role_name": { + "type": "string", + "example": "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", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# 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", + "format": "uri", + "nullable": true + } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "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" + ] + } + } + }, + "secret_scanning_validity_checks": { + "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" ] } }, @@ -235466,17 +238156,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=", @@ -235496,1397 +238180,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/enterprise-cloud@latest//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", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "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/enterprise-cloud@latest//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", - "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/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - }, - "nullable": true - }, - "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "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", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# 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", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "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" - ] - } - } - }, - "secret_scanning_validity_checks": { - "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_validity_checks": { - "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_validity_checks": { + "status": "disabled" + } } } ] @@ -238650,327 +240034,463 @@ "deprecated": true } }, - "/projects/columns/cards/{card_id}": { + "/rate_limit": { "get": { - "summary": "Get a project card", - "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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-card", + "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], + "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" - }, - "id": { - "description": "The project card's ID", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" - }, - "note": { - "type": "string", - "example": "Add payload for delete Project column", - "nullable": true - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", + "resources": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "core": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "graphql": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "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" + ] }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "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" + ] }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "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" + ] }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "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" + ] }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "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" + ] }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "scim": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "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" + ] }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "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" + ] }, - "type": { - "type": "string", - "example": "User" + "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" }, - "site_admin": { - "type": "boolean" + "remaining": { + "type": "integer" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "reset": { + "type": "integer" }, - "user_view_type": { - "type": "string", - "example": "public" + "used": { + "type": "integer" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "content_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" + "limit", + "remaining", + "reset", + "used" + ] } }, "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" + "rate", + "resources" ] }, "examples": { "default": { "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "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 + "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 + } }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" + "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" } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { + }, + "X-RateLimit-Remaining": { + "example": 4999, "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-Reset": { + "example": 1590701888, + "schema": { + "type": "integer", + "format": "timestamp" } } } }, + "304": { + "description": "Not modified" + }, "404": { "description": "Resource not found", "content": { @@ -238999,99 +240519,73 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an existing project card", - "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/enterprise-cloud@latest//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-card", + "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository" }, "parameters": [ { - "name": "card_id", - "description": "The unique identifier of the card.", + "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": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "note": { - "description": "The project card's note", - "example": "Update all gems", - "type": "string", - "nullable": true - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - } - } - }, - "examples": { - "default": { - "summary": "Change the note on the card", - "value": { - "note": "Add payload for delete Project column" - } - } - } + }, + { + "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 Card", - "description": "Project cards represent a scope of work.", + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" - }, "id": { - "description": "The project card's ID", - "example": 42, "type": "integer", - "format": "int64" + "format": "int64", + "example": 1296269 }, "node_id": { "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "note": { + "name": { "type": "string", - "example": "Add payload for delete Project column", - "nullable": true + "example": "Hello-World" }, - "creator": { + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -239213,2994 +240707,1194 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ] }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" + "private": { + "type": "boolean" }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true }, - "project_id": { - "type": "string" + "fork": { + "type": "boolean" }, - "column_url": { + "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "content_url": { + "archive_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "project_url": { + "assignees_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "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": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "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" + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "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" + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "documentation_url": { - "type": "string" + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project card", - "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-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "documentation_url": { - "type": "string" + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/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" + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, - "documentation_url": { - "type": "string" + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, - "url": { - "type": "string" + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "documentation_url": { - "type": "string" + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "url": { - "type": "string" + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/cards/{card_id}/moves": { - "post": { - "summary": "Move a project card", - "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-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", - "example": "bottom", - "type": "string", - "pattern": "^(?:top|bottom|after:\\d+)$" - }, - "column_id": { - "description": "The unique identifier of the column the card should be moved to", - "example": 42, - "type": "integer" - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the card to the bottom of the column", - "value": { - "column_id": 42, - "position": "bottom" - } - } - } - } - } - }, - "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": { - "type": "object", - "properties": { - "message": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "documentation_url": { - "type": "string" + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "resource": { - "type": "string" - }, - "field": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "documentation_url": { - "type": "string" + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "url": { - "type": "string" + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "503": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, - "message": { - "type": "string" + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "documentation_url": { - "type": "string" + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "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" + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - "documentation_url": { - "type": "string" + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "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/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column" - }, - "parameters": [ - { - "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": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { + "labels_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, - "project_url": { + "languages_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/120" + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, - "cards_url": { + "merges_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, - "node_id": { + "milestones_url": { "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" - }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, - "created_at": { + "notifications_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, - "updated_at": { + "pulls_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "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" - }, - "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" + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, - "url": { - "type": "string" + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" }, - "documentation_url": { - "type": "string" + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, - "url": { - "type": "string" + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{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 - }, - "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/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-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": { - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Rename the project column", - "value": { - "name": "To Do" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { + "subscribers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, - "project_url": { + "subscription_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/120" + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, - "cards_url": { + "tags_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" + "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, - "node_id": { + "teams_url": { "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, - "created_at": { + "clone_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" + "example": "https://github.com/octocat/Hello-World.git" }, - "updated_at": { + "mirror_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "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" + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true }, - "documentation_url": { - "type": "string" + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, - "url": { - "type": "string" + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true }, - "documentation_url": { - "type": "string" + "language": { + "type": "string", + "nullable": true }, - "url": { - "type": "string" + "forks_count": { + "type": "integer", + "example": 9 }, - "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/enterprise-cloud@latest//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" + "stargazers_count": { + "type": "integer", + "example": 80 }, - "documentation_url": { - "type": "string" + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "default_branch": { + "type": "string", + "example": "master" }, - "documentation_url": { - "type": "string" + "open_issues_count": { + "type": "integer", + "example": 0 }, - "url": { - "type": "string" + "is_template": { + "type": "boolean", + "example": true }, - "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}/cards": { - "get": { - "summary": "List project cards", - "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-cards", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "archived_state", - "description": "Filters the project cards that are returned by the card's state.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "archived", - "not_archived" - ], - "default": "not_archived" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" - }, - "id": { - "description": "The project card's ID", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" - }, - "note": { - "type": "string", - "example": "Add payload for delete Project column", - "nullable": true - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { + "topics": { + "type": "array", + "items": { "type": "string" }, - "column_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "content_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - } + "example": [ + "octocat", + "atom", + "electron", + "API" + ] }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "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": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - ] - } - } - } - }, - "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" + "has_issues": { + "type": "boolean", + "example": true }, - "documentation_url": { - "type": "string" + "has_projects": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "has_wiki": { + "type": "boolean", + "example": true }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "has_pages": { + "type": "boolean" }, - "documentation_url": { - "type": "string" + "has_downloads": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "has_discussions": { + "type": "boolean", + "example": true }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create a project card", - "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/create-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card" - }, - "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": { - "oneOf": [ - { - "type": "object", - "properties": { - "note": { - "description": "The project card's note", - "example": "Update all gems", - "type": "string", - "nullable": true - } + "archived": { + "type": "boolean" }, - "required": [ - "note" - ] - }, - { - "type": "object", - "properties": { - "content_id": { - "description": "The unique identifier of the content associated with the card", - "example": 42, - "type": "integer" - }, - "content_type": { - "description": "The piece of content associated with the card", - "example": "PullRequest", - "type": "string" - } + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." }, - "required": [ - "content_id", - "content_type" - ] - } - ] - }, - "examples": { - "default": { - "summary": "Create a new card", - "value": { - "note": "Add payload for delete Project column" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { + "visibility": { + "description": "The repository visibility: public, private, or internal.", "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" + "example": "public" }, - "id": { - "description": "The project card's ID", - "example": 42, - "type": "integer", - "format": "int64" + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" }, - "node_id": { + "created_at": { "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" + "format": "date-time", + "example": "2011-01-26T19:01:12Z" }, - "note": { + "updated_at": { "type": "string", - "example": "Add payload for delete Project column", - "nullable": true + "format": "date-time", + "example": "2011-01-26T19:14:43Z" }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", + "permissions": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "admin": { + "type": "boolean" }, - "email": { - "nullable": true, - "type": "string" + "maintain": { + "type": "boolean" }, - "login": { - "type": "string", - "example": "octocat" + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" }, + "pull": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "allow_rebase_merge": { + "type": "boolean", + "example": true + }, + "template_repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "format": "int64", - "example": 1 + "format": "int64" }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "avatar_url": { + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "https://github.com/octocat/Hello-World" }, - "gravatar_id": { + "description": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", + "example": "This your first repo!", "nullable": true }, + "fork": { + "type": "boolean" + }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "html_url": { + "archive_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "followers_url": { + "assignees_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "following_url": { + "blobs_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "gists_url": { + "branches_url": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "starred_url": { + "collaborators_url": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "subscriptions_url": { + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "organizations_url": { + "deployments_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "repos_url": { + "downloads_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "received_events_url": { + "forks_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "type": { + "git_commits_url": { "type": "string", - "example": "User" + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "site_admin": { - "type": "boolean" + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "starred_at": { + "git_tags_url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - "user_view_type": { + "git_url": { "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "content_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "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": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - } - } - } - } - }, - "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", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "example": "git:github.com/octocat/Hello-World.git" }, - "documentation_url": { - "type": "string" + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - }, - { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - "documentation_url": { - "type": "string" + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ] - } - } - } - }, - "503": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { "type": "string" } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "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/enterprise-cloud@latest//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.", - "example": "last", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$" - } - }, - "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" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "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 - } - }, - "/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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "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" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "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 - } - }, - "/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/enterprise-cloud@latest//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", - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "example": "write", - "type": "string" - } - }, - "nullable": true - }, - "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" - }, - "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" + }, + "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" + ], + "nullable": true }, - "documentation_url": { - "type": "string" + "temp_clone_token": { + "type": "string", + "nullable": true }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "allow_squash_merge": { + "type": "boolean", + "example": true }, - "documentation_url": { - "type": "string" + "allow_auto_merge": { + "type": "boolean", + "example": false }, - "url": { - "type": "string" + "delete_branch_on_merge": { + "type": "boolean", + "example": false }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "allow_merge_commit": { + "type": "boolean", + "example": true }, - "documentation_url": { - "type": "string" + "allow_update_branch": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "use_squash_pr_title_as_default": { + "type": "boolean", + "example": false }, - "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/enterprise-cloud@latest//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" + "squash_merge_commit_title": { + "type": "string", + "example": "PR_TITLE", + "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)." }, - "documentation_url": { - "type": "string" + "squash_merge_commit_message": { + "type": "string", + "example": "PR_BODY", + "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." }, - "url": { - "type": "string" + "merge_commit_title": { + "type": "string", + "example": "PR_TITLE", + "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)." }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "merge_commit_message": { + "type": "string", + "example": "PR_BODY", + "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." }, - "documentation_url": { - "type": "string" + "allow_forking": { + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "web_commit_signoff_required": { + "type": "boolean", + "example": false }, - "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" + "subscribers_count": { + "type": "integer", + "example": 42 }, - "documentation_url": { - "type": "string" + "network_count": { + "type": "integer", + "example": 0 }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" } - } - } - } - } - } - } - }, - "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 - } - }, - "/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/enterprise-cloud@latest//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" + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true }, - "user": { + "organization": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -242324,2406 +242018,223 @@ "url" ], "nullable": true - } - }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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": { + "parent": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { - "core": { - "title": "Rate Limit", + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" + "key": { + "type": "string", + "example": "mit" }, - "reset": { - "type": "integer" + "name": { + "type": "string", + "example": "MIT License" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "graphql": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" }, - "remaining": { - "type": "integer" + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" }, - "reset": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" }, - "used": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "limit", - "remaining", - "reset", - "used" - ] + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true }, - "search": { - "title": "Rate Limit", + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "limit": { - "type": "integer" + "admin": { + "type": "boolean" }, - "remaining": { - "type": "integer" + "pull": { + "type": "boolean" }, - "reset": { - "type": "integer" + "triage": { + "type": "boolean" }, - "used": { - "type": "integer" + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, "required": [ - "limit", - "remaining", - "reset", - "used" + "admin", + "pull", + "push" ] }, - "code_search": { - "title": "Rate Limit", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "limit": { - "type": "integer" + "name": { + "nullable": true, + "type": "string" }, - "remaining": { - "type": "integer" + "email": { + "nullable": true, + "type": "string" }, - "reset": { - "type": "integer" + "login": { + "type": "string", + "example": "octocat" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "source_import": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "remaining": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "reset": { - "type": "integer" + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "integration_manifest": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "remaining": { - "type": "integer" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "reset": { - "type": "integer" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_upload": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "remaining": { - "type": "integer" + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "reset": { - "type": "integer" + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "actions_runner_registration": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "remaining": { - "type": "integer" + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "reset": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "scim": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, - "remaining": { - "type": "integer" + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "reset": { - "type": "integer" + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_snapshots": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" + "type": { + "type": "string", + "example": "User" }, - "remaining": { - "type": "integer" + "site_admin": { + "type": "boolean" }, - "reset": { - "type": "integer" + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" }, - "used": { - "type": "integer" + "user_view_type": { + "type": "string", + "example": "public" } }, "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 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", - "example": 108 - }, - "default_branch": { - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "example": true - }, - "has_projects": { - "type": "boolean", - "example": true - }, - "has_wiki": { - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "example": true - }, - "has_discussions": { - "type": "boolean", - "example": 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", - "example": "public" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "example": true - }, - "template_repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 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", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": 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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" - }, - "lexical_commit_sha": { - "type": "string" - } - } - } - }, - "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" - ], - "nullable": true - }, - "temp_clone_token": { - "type": "string", - "nullable": true - }, - "allow_squash_merge": { - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "type": "boolean", - "example": false - }, - "allow_merge_commit": { - "type": "boolean", - "example": true - }, - "allow_update_branch": { - "type": "boolean", - "example": true - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "example": false - }, - "squash_merge_commit_title": { - "type": "string", - "example": "PR_TITLE", - "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", - "example": "PR_BODY", - "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", - "example": "PR_TITLE", - "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", - "example": "PR_BODY", - "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_forking": { - "type": "boolean", - "example": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "subscribers_count": { - "type": "integer", - "example": 42 - }, - "network_count": { - "type": "integer", - "example": 0 - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "parent": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "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": { @@ -251639,6 +249150,608 @@ } } }, + "/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/enterprise-cloud@latest//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", + "example": 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/enterprise-cloud@latest//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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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/enterprise-cloud@latest//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", + "example": 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/enterprise-cloud@latest//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", + "example": 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "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", @@ -277562,6 +275675,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -277582,6 +275696,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -295780,6 +293895,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -295800,6 +293916,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -333647,6 +331764,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -333667,6 +331785,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -339401,6 +337520,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -339421,6 +337541,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -344754,6 +342875,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -344774,6 +342896,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345300,6 +343423,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345320,6 +343444,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345870,6 +343995,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -345890,6 +344016,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -381848,6 +379975,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.", @@ -464232,6 +462367,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -464252,6 +462388,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -495105,6 +493242,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -495125,6 +493263,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -526189,6 +524328,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.", @@ -528429,7 +526591,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" @@ -528499,6 +526661,11 @@ "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", "type": "string", "nullable": true + }, + "assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true } }, "anyOf": [ @@ -528506,6 +526673,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -528515,6 +526687,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -529491,7 +527675,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 + } } } } @@ -529505,7 +527709,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", @@ -566791,6 +564995,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -567003,6 +565208,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -579973,17 +578179,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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy" }, "parameters": [ { @@ -580022,42 +578228,28 @@ "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", + "example": 1296269 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "type": "string" - }, - "body": { "type": "string", - "nullable": true - }, - "number": { - "type": "integer" + "example": "Hello-World" }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -580181,55 +578373,550 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "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", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "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", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, "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", + "example": "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", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# 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", + "format": "uri", + "nullable": true + } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "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" + ] + } + } + }, + "secret_scanning_validity_checks": { + "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" ] } }, @@ -580237,17 +578924,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=", @@ -580267,1576 +578948,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/enterprise-cloud@latest//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", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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/enterprise-cloud@latest//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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "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", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# 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", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "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" - ] - } - } - }, - "secret_scanning_validity_checks": { - "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_validity_checks": { - "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_validity_checks": { + "status": "disabled" + } } } ] @@ -608846,6 +606048,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.", @@ -657687,6 +654897,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.", @@ -664124,51 +661342,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/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest//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": { @@ -664359,7 +661806,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", @@ -664369,37 +661849,509 @@ "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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/enterprise-cloud@latest//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.", + "example": "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", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was last updated." + } + }, + "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": { @@ -724616,6 +722568,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -726997,6 +724956,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -858270,6 +856236,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.", @@ -860878,6 +858852,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.", @@ -863393,6 +861375,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.", @@ -865908,6 +863898,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.", @@ -868555,6 +866553,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.", @@ -871209,6 +869215,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.", @@ -875486,6 +873500,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.", @@ -1270976,949 +1268998,4357 @@ ] } }, - "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." + }, + "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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" + } + } + } + } + } + } + } + } + } + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + }, + "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", + "nullable": true + }, + "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", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "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", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": 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", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "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", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + }, + "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/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "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", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "organization": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": 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", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": 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", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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", @@ -1272047,7 +1273477,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1272062,8 +1273492,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1272071,13 +1273502,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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", - "operationId": "repository/transferred", + "summary": "This event occurs when there is activity relating to 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1272142,200 +1273573,180 @@ "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": { + "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", + "nullable": true, + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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", + "nullable": true + }, + "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", + "nullable": true, + "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", @@ -1273843,7 +1275254,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1273859,23 +1275270,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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1273940,15 +1275349,191 @@ "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", + "nullable": true + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "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/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", @@ -1275455,6 +1277040,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1275470,21 +1277056,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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1275551,13 +1277135,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": { @@ -1277256,11 +1278840,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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1277327,13 +1278911,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": { @@ -1277344,9 +1278928,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1277366,10 +1278947,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": "string", - "nullable": true - }, "dismiss_reason": { "type": "string" }, @@ -1277465,9 +1279042,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1277507,7 +1279081,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1279014,279 +1280589,855 @@ "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/enterprise-cloud@latest//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", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//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": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { + "type": "string", + "description": "The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//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", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true + }, + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, "enterprise": { "title": "Enterprise", @@ -1280795,8 +1282946,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1280810,21 +1282960,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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1280889,179 +1283040,630 @@ "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": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", - "type": "object", + "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", + "description": "The reason for resolving the alert.", "nullable": true, - "required": [ - "login", - "id" - ], + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "avatar_url": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "format": "uri" + "example": "octocat" }, - "deleted": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "email": { + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "events_url": { + "url": { "type": "string", - "format": "uri-template" + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "gravatar_id": { - "type": "string" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "html_url": { + "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "id": { - "type": "integer" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "login": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//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", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { "name": { + "nullable": true, "type": "string" }, - "node_id": { + "email": { + "nullable": true, "type": "string" }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, "organizations_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "repos_url": { + "type": { "type": "string", - "format": "uri" + "example": "User" }, "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, "starred_url": { "type": "string", - "format": "uri-template" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] + "example": "User" }, - "url": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "uri" + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - }, - "external_identifier": { - "type": "string" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "external_reference": { + "push_protection_bypass_request_reviewer_comment": { "type": "string", - "nullable": true, - "format": "uri" - }, - "fix_reason": { - "type": "string" + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true }, - "fixed_at": { + "push_protection_bypass_request_comment": { "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true }, - "node_id": { - "type": "string" + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true }, - "number": { - "type": "integer" + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true }, - "severity": { - "type": "string" + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" - ] + "assigned_to": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true } } }, @@ -1282572,8 +1285174,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1282587,21 +1285188,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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -1282666,7 +1285268,7 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { @@ -1283293,74 +1285895,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/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1283382,6 +1285916,314 @@ "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.", + "example": "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", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_title_url" + ] + }, + { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + "required": [ + "issue_body_url" + ] + }, + { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + } + ] + } + } + }, "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.", @@ -1284798,10 +1287640,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" + } + } } } } @@ -1284813,8 +1287830,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1284823,13 +1287841,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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1284894,13 +1287912,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": { @@ -1285521,6 +1288539,74 @@ } } }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, "installation": { "title": "Simple Installation", "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1285542,314 +1288628,6 @@ "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.", - "example": "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", - "example": "/example/secrets.txt" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "blob_url": { - "type": "string", - "description": "The API URL to get the associated blob resource" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "commit_url": { - "type": "string", - "description": "The API URL to get the associated commit resource" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "blob_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The file path of the wiki page", - "example": "/example/Home.md" - }, - "start_line": { - "type": "number", - "description": "Line number at which the secret starts in the file" - }, - "end_line": { - "type": "number", - "description": "Line number at which the secret ends in the file" - }, - "start_column": { - "type": "number", - "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." - }, - "end_column": { - "type": "number", - "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." - }, - "blob_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated blob", - "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" - }, - "page_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki page", - "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_sha": { - "type": "string", - "description": "SHA-1 hash ID of the associated commit", - "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" - }, - "commit_url": { - "type": "string", - "description": "The GitHub URL to get the associated wiki commit", - "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" - } - }, - "required": [ - "path", - "start_line", - "end_line", - "start_column", - "end_column", - "blob_sha", - "page_url", - "commit_sha", - "commit_url" - ] - }, - { - "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", - "type": "object", - "properties": { - "issue_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_title_url" - ] - }, - { - "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", - "type": "object", - "properties": { - "issue_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" - } - }, - "required": [ - "issue_body_url" - ] - }, - { - "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", - "type": "object", - "properties": { - "issue_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the issue comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "issue_comment_url" - ] - }, - { - "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", - "type": "object", - "properties": { - "discussion_title_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082" - } - }, - "required": [ - "discussion_title_url" - ] - }, - { - "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", - "type": "object", - "properties": { - "discussion_body_url": { - "type": "string", - "format": "uri", - "description": "The URL to the discussion where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussion-4566270" - } - }, - "required": [ - "discussion_body_url" - ] - }, - { - "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", - "type": "object", - "properties": { - "discussion_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the discussion comment where the secret was detected.", - "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" - } - }, - "required": [ - "discussion_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", - "type": "object", - "properties": { - "pull_request_title_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_title_url" - ] - }, - { - "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", - "type": "object", - "properties": { - "pull_request_body_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" - } - }, - "required": [ - "pull_request_body_url" - ] - }, - { - "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", - "type": "object", - "properties": { - "pull_request_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" - } - }, - "required": [ - "pull_request_comment_url" - ] - }, - { - "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", - "type": "object", - "properties": { - "pull_request_review_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" - } - }, - "required": [ - "pull_request_review_url" - ] - }, - { - "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", - "type": "object", - "properties": { - "pull_request_review_comment_url": { - "type": "string", - "format": "uri", - "description": "The API URL to get the pull request review comment where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" - } - }, - "required": [ - "pull_request_review_comment_url" - ] - } - ] - } - } - }, "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.", @@ -1287266,185 +1290044,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" - } - } } } } @@ -1287456,9 +1290059,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1287467,11 +1290069,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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was detected in a public repo.", - "operationId": "secret-scanning-alert/publicly-leaked", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1287538,13 +1290140,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": { @@ -1289695,11 +1292297,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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1289766,13 +1292368,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": { @@ -1291923,11 +1294525,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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1291994,13 +1294596,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": { @@ -1292621,6 +1295223,130 @@ } } }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index e891ea64d..e92d04ed7 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.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 @@ -448,7 +446,7 @@ paths: The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. schema: type: string - - &104 + - &108 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For @@ -457,7 +455,7 @@ paths: required: false schema: type: string - - &105 + - &109 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For @@ -466,7 +464,7 @@ paths: required: false schema: type: string - - &106 + - &110 name: direction description: The direction to sort the results by. in: query @@ -687,7 +685,7 @@ paths: required: - vector_string - score - cvss_severities: &125 + cvss_severities: &129 type: object nullable: true properties: @@ -727,7 +725,7 @@ paths: required: - vector_string - score - epss: &126 + epss: &130 type: object nullable: true readOnly: true @@ -865,7 +863,7 @@ paths: - subscriptions_url - type - url - type: &428 + type: &436 type: string description: The type of credit the user is receiving. enum: @@ -998,7 +996,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &250 + schema: &257 title: Validation Error Simple description: Validation Error Simple type: object @@ -1031,7 +1029,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &750 + - &751 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1149,7 +1147,7 @@ paths: GitHub. type: object nullable: true - properties: &212 + properties: &217 id: description: Unique identifier of the GitHub app example: 37 @@ -1171,7 +1169,7 @@ paths: title: Enterprise description: An enterprise on GitHub. type: object - properties: &134 + properties: &138 description: description: A short description of the enterprise. type: string @@ -1213,7 +1211,7 @@ paths: avatar_url: type: string format: uri - required: &135 + required: &139 - id - node_id - name @@ -1282,7 +1280,7 @@ paths: about itself. example: 5 type: integer - required: &213 + required: &218 - id - node_id - owner @@ -1587,7 +1585,7 @@ paths: schema: type: integer default: 30 - - &338 + - &345 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 @@ -1603,7 +1601,7 @@ paths: application/json: schema: type: array - items: &339 + items: &346 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1683,7 +1681,7 @@ paths: - installation_id - repository_id examples: - default: &340 + default: &347 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1715,7 +1713,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &760 + schema: &761 title: Scim Error description: Scim Error type: object @@ -1742,7 +1740,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &249 + schema: &256 title: Validation Error description: Validation Error type: object @@ -1811,7 +1809,7 @@ paths: description: Response content: application/json: - schema: &341 + schema: &348 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1925,7 +1923,7 @@ paths: - request - response examples: - default: &342 + default: &349 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2126,7 +2124,7 @@ paths: parameters: - *17 - *19 - - &217 + - &222 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) @@ -2217,6 +2215,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 @@ -2718,7 +2723,7 @@ paths: suspended_at: suspended_by: headers: - Link: &43 + Link: &47 example: ; rel="next", ; rel="last" schema: @@ -2759,7 +2764,7 @@ paths: application/json: schema: *22 examples: - default: &84 + default: &88 value: id: 1 account: @@ -2909,11 +2914,11 @@ paths: - selected repositories: type: array - items: &74 + items: &78 title: Repository description: A repository on GitHub. type: object - properties: &406 + properties: &413 id: description: Unique identifier of the repository example: 42 @@ -2933,7 +2938,7 @@ paths: title: License Simple description: License Simple type: object - properties: &228 + properties: &233 key: type: string example: mit @@ -2955,7 +2960,7 @@ paths: html_url: type: string format: uri - required: &229 + required: &234 - key - name - url @@ -3351,7 +3356,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &407 + required: &414 - archive_url - assignees_url - blobs_url @@ -7487,6 +7492,158 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: enterprises + "/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/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: &43 + 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 + example: 14 + examples: + default: &44 + value: + max_cache_retention_days: 80 + '403': *29 + '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/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - *41 + requestBody: + required: true + content: + application/json: + schema: *43 + examples: + selected_actions: *44 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: &45 + 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 + example: 10 + examples: + default: &46 + value: + max_cache_size_gb: 150 + '403': *29 + '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/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - *41 + requestBody: + required: true + content: + application/json: + schema: *45 + examples: + selected_actions: *46 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache "/enterprises/{enterprise}/actions/cache/usage": get: summary: Get GitHub Actions cache usage for an enterprise @@ -7508,7 +7665,7 @@ paths: description: Response content: application/json: - schema: &251 + schema: &258 type: object properties: total_active_caches_count: @@ -7523,12 +7680,12 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &252 + default: &259 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 headers: - Link: *43 + Link: *47 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -7566,7 +7723,7 @@ paths: type: integer runners: type: array - items: &44 + items: &48 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -7620,7 +7777,7 @@ paths: - display_name - source nullable: true - machine_size_details: &52 + machine_size_details: &56 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -7716,7 +7873,7 @@ paths: - public_ip_enabled - platform examples: - default: &253 + default: &260 value: total_count: 2 runners: @@ -7758,7 +7915,7 @@ paths: public_ips: [] last_active_on: '2023-04-26T15:23:37Z' headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -7854,9 +8011,9 @@ paths: description: Response content: application/json: - schema: *44 + schema: *48 examples: - default: &53 + default: &57 value: id: 5 name: My hosted ubuntu runner @@ -7913,7 +8070,7 @@ paths: type: integer images: type: array - items: &45 + items: &49 title: GitHub-hosted runner custom image details description: Provides details of a custom runner image type: object @@ -7964,7 +8121,7 @@ paths: - latest_version - state examples: - default: &47 + default: &51 value: total_count: 2 image_versions: @@ -7997,7 +8154,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-enterprise-custom-image-definition-for-github-actions-hosted-runners parameters: - *41 - - &46 + - &50 name: image_definition_id description: Image definition ID of custom image in: path @@ -8009,9 +8166,9 @@ paths: description: Response content: application/json: - schema: *45 + schema: *49 examples: - default: &254 + default: &261 value: id: 1 platform: linux-x64 @@ -8040,7 +8197,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-enterprise parameters: - *41 - - *46 + - *50 responses: '204': description: Response @@ -8063,7 +8220,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-enterprise parameters: - - *46 + - *50 - *41 responses: '200': @@ -8080,7 +8237,7 @@ paths: type: integer image_versions: type: array - items: &48 + items: &52 title: GitHub-hosted runner custom image version details. description: Provides details of a hosted runner custom image version @@ -8113,7 +8270,7 @@ paths: - created_on - state_details examples: - default: *47 + default: *51 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -8135,8 +8292,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-an-enterprise-custom-image-for-github-actions-hosted-runners parameters: - *41 - - *46 - - &49 + - *50 + - &53 name: version description: Version of a custom image in: path @@ -8149,9 +8306,9 @@ paths: description: Response content: application/json: - schema: *48 + schema: *52 examples: - default: &255 + default: &262 value: version: 1.0.0 size_gb: 75 @@ -8176,8 +8333,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-enterprise parameters: - *41 - - *46 - - *49 + - *50 + - *53 responses: '204': description: Response @@ -8214,7 +8371,7 @@ paths: type: integer images: type: array - items: &50 + items: &54 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -8250,7 +8407,7 @@ paths: - display_name - source examples: - default: &51 + default: &55 value: id: ubuntu-20.04 platform: linux-x64 @@ -8290,9 +8447,9 @@ paths: type: integer images: type: array - items: *50 + items: *54 examples: - default: *51 + default: *55 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -8315,7 +8472,7 @@ paths: description: Response content: application/json: - schema: &256 + schema: &263 type: object properties: public_ips: @@ -8340,7 +8497,7 @@ paths: required: - public_ips examples: - default: &257 + default: &264 value: public_ips: current_usage: 17 @@ -8378,9 +8535,9 @@ paths: type: integer machine_specs: type: array - items: *52 + items: *56 examples: - default: &258 + default: &265 value: id: 4-core cpu_cores: 4 @@ -8448,7 +8605,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-enterprise parameters: - *41 - - &54 + - &58 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -8460,11 +8617,11 @@ paths: description: Response content: application/json: - schema: *44 + schema: *48 examples: - default: *53 + default: *57 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -8483,7 +8640,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-enterprise parameters: - *41 - - *54 + - *58 requestBody: required: true content: @@ -8526,9 +8683,9 @@ paths: description: Response content: application/json: - schema: *44 + schema: *48 examples: - default: *53 + default: *57 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -8545,15 +8702,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-enterprise parameters: - *41 - - *54 + - *58 responses: '202': description: Response content: application/json: - schema: *44 + schema: *48 examples: - default: *53 + default: *57 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -8621,7 +8778,7 @@ paths: schema: type: object properties: - enabled_organizations: &55 + enabled_organizations: &59 type: string description: The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. @@ -8634,7 +8791,7 @@ paths: description: The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`. - allowed_actions: &56 + allowed_actions: &60 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -8642,12 +8799,12 @@ paths: - all - local_only - selected - selected_actions_url: &261 + selected_actions_url: &268 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: &57 + sha_pinning_required: &61 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -8689,9 +8846,9 @@ paths: schema: type: object properties: - enabled_organizations: *55 - allowed_actions: *56 - sha_pinning_required: *57 + enabled_organizations: *59 + allowed_actions: *60 + sha_pinning_required: *61 required: - enabled_organizations examples: @@ -8722,7 +8879,7 @@ paths: description: Successfully retrieved the artifact and log retention settings content: application/json: - schema: &263 + schema: &270 type: object properties: days: @@ -8740,7 +8897,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &761 + '401': &762 description: Authorization failure '404': *6 x-github: @@ -8768,7 +8925,7 @@ paths: required: true content: application/json: - schema: &264 + schema: &271 type: object properties: days: @@ -8803,7 +8960,7 @@ paths: description: Response content: application/json: - schema: &58 + schema: &62 type: object properties: approval_policy: @@ -8817,7 +8974,7 @@ paths: required: - approval_policy examples: - default: &265 + default: &272 value: approval_policy: first_time_contributors '404': *6 @@ -8846,7 +9003,7 @@ paths: required: true content: application/json: - schema: *58 + schema: *62 examples: default: summary: Set approval policy to first time contributors @@ -8875,7 +9032,7 @@ paths: description: Response content: application/json: - schema: &266 + schema: &273 type: object required: - run_workflows_from_fork_pull_requests @@ -8901,7 +9058,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &59 + default: &63 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -8929,7 +9086,7 @@ paths: required: true content: application/json: - schema: &267 + schema: &274 type: object required: - run_workflows_from_fork_pull_requests @@ -8952,7 +9109,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *59 + default: *63 responses: '204': description: Empty response for successful settings update @@ -8992,11 +9149,11 @@ paths: type: number organizations: type: array - items: &69 + items: &73 title: Organization Simple description: A GitHub organization. type: object - properties: &116 + properties: &120 login: type: string example: github @@ -9037,7 +9194,7 @@ paths: type: string example: A great organization nullable: true - required: &117 + required: &121 - login - url - id @@ -9054,7 +9211,7 @@ paths: - total_count - organizations examples: - default: &70 + default: &74 value: total_count: 1 organizations: @@ -9133,7 +9290,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *41 - - &60 + - &64 name: org_id description: The unique identifier of the organization. in: path @@ -9162,7 +9319,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *41 - - *60 + - *64 responses: '204': description: Response @@ -9191,7 +9348,7 @@ paths: description: Response content: application/json: - schema: &61 + schema: &65 type: object properties: github_owned_allowed: @@ -9212,7 +9369,7 @@ paths: items: type: string examples: - default: &62 + default: &66 value: github_owned_allowed: true verified_allowed: false @@ -9245,9 +9402,9 @@ paths: required: true content: application/json: - schema: *61 + schema: *65 examples: - selected_actions: *62 + selected_actions: *66 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -9352,17 +9509,17 @@ paths: description: Success response content: application/json: - schema: &270 + schema: &277 type: object properties: - default_workflow_permissions: &63 + default_workflow_permissions: &67 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &64 + can_approve_pull_request_reviews: &68 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -9370,7 +9527,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &65 + default: &69 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -9400,13 +9557,13 @@ paths: required: true content: application/json: - schema: &271 + schema: &278 type: object properties: - default_workflow_permissions: *63 - can_approve_pull_request_reviews: *64 + default_workflow_permissions: *67 + can_approve_pull_request_reviews: *68 examples: - default: *65 + default: *69 responses: '204': description: Success response @@ -9451,7 +9608,7 @@ paths: type: number runner_groups: type: array - items: &66 + items: &70 type: object properties: id: @@ -9630,9 +9787,9 @@ paths: description: Response content: application/json: - schema: *66 + schema: *70 examples: - default: &67 + default: &71 value: id: 2 name: octo-runner-group @@ -9667,7 +9824,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise parameters: - *41 - - &68 + - &72 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -9679,9 +9836,9 @@ paths: description: Response content: application/json: - schema: *66 + schema: *70 examples: - default: *67 + default: *71 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -9701,7 +9858,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise parameters: - *41 - - *68 + - *72 requestBody: required: false content: @@ -9753,7 +9910,7 @@ paths: description: Response content: application/json: - schema: *66 + schema: *70 examples: default: value: @@ -9789,7 +9946,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise parameters: - *41 - - *68 + - *72 responses: '204': description: Response @@ -9813,7 +9970,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *68 + - *72 - *17 - *19 responses: @@ -9828,12 +9985,12 @@ paths: type: number organizations: type: array - items: *69 + items: *73 required: - total_count - organizations examples: - default: *70 + default: *74 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -9853,7 +10010,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *68 + - *72 requestBody: required: true content: @@ -9899,8 +10056,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *68 - - *60 + - *72 + - *64 responses: '204': description: Response @@ -9923,8 +10080,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *68 - - *60 + - *72 + - *64 responses: '204': description: Response @@ -9948,7 +10105,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise parameters: - *41 - - *68 + - *72 - *17 - *19 responses: @@ -9963,7 +10120,7 @@ paths: type: number runners: type: array - items: &72 + items: &76 title: Self hosted runners description: A self hosted runner type: object @@ -9992,7 +10149,7 @@ paths: type: boolean labels: type: array - items: &76 + items: &80 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -10025,7 +10182,7 @@ paths: - total_count - runners examples: - default: &73 + default: &77 value: total_count: 2 runners: @@ -10065,7 +10222,7 @@ paths: name: no-gpu type: custom headers: - Link: *43 + Link: *47 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -10085,7 +10242,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise parameters: - *41 - - *68 + - *72 requestBody: required: true content: @@ -10130,8 +10287,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise parameters: - *41 - - *68 - - &71 + - *72 + - &75 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -10160,8 +10317,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise parameters: - *41 - - *68 - - *71 + - *72 + - *75 responses: '204': description: Response @@ -10204,11 +10361,11 @@ paths: type: number runners: type: array - items: *72 + items: *76 examples: - default: *73 + default: *77 headers: - Link: *43 + Link: *47 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -10236,7 +10393,7 @@ paths: application/json: schema: type: array - items: &275 + items: &282 title: Runner Application description: Runner Application type: object @@ -10261,7 +10418,7 @@ paths: - download_url - filename examples: - default: &276 + default: &283 value: - os: osx architecture: x64 @@ -10345,7 +10502,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &277 + '201': &284 description: Response content: application/json: @@ -10355,7 +10512,7 @@ paths: - runner - encoded_jit_config properties: - runner: *72 + runner: *76 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -10384,7 +10541,7 @@ paths: encoded_jit_config: abc123 '404': *6 '422': *7 - '409': &114 + '409': &118 description: Conflict content: application/json: @@ -10422,7 +10579,7 @@ paths: description: Response content: application/json: - schema: &75 + schema: &79 title: Authentication Token description: Authentication Token type: object @@ -10444,7 +10601,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *74 + items: *78 single_file: type: string example: config.yaml @@ -10460,7 +10617,7 @@ paths: - token - expires_at examples: - default: &278 + default: &285 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -10498,9 +10655,9 @@ paths: description: Response content: application/json: - schema: *75 + schema: *79 examples: - default: &279 + default: &286 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -10524,15 +10681,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *71 + - *75 responses: '200': description: Response content: application/json: - schema: *72 + schema: *76 examples: - default: &280 + default: &287 value: id: 23 name: MBP @@ -10572,7 +10729,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise parameters: - *41 - - *71 + - *75 responses: '204': description: Response @@ -10597,9 +10754,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *71 + - *75 responses: - '200': &77 + '200': &81 description: Response content: application/json: @@ -10613,7 +10770,7 @@ paths: type: integer labels: type: array - items: *76 + items: *80 examples: default: value: @@ -10651,7 +10808,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *71 + - *75 requestBody: required: true content: @@ -10675,7 +10832,7 @@ paths: - gpu - accelerated responses: - '200': *77 + '200': *81 '404': *6 '422': *7 x-github: @@ -10698,7 +10855,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *71 + - *75 requestBody: required: true content: @@ -10723,7 +10880,7 @@ paths: - gpu - accelerated responses: - '200': *77 + '200': *81 '404': *6 '422': *7 x-github: @@ -10746,9 +10903,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *71 + - *75 responses: - '200': &281 + '200': &288 description: Response content: application/json: @@ -10762,7 +10919,7 @@ paths: type: integer labels: type: array - items: *76 + items: *80 examples: default: value: @@ -10803,8 +10960,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *71 - - &282 + - *75 + - &289 name: name description: The name of a self-hosted runner's custom label. in: path @@ -10812,7 +10969,7 @@ paths: schema: type: string responses: - '200': *77 + '200': *81 '404': *6 '422': *7 x-github: @@ -10837,20 +10994,20 @@ paths: description: Response content: application/json: - schema: &82 + schema: &86 title: Announcement Banner description: Announcement at either the repository, organization, or enterprise level type: object properties: - announcement: &78 + announcement: &82 type: string description: The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." example: Very **important** announcement about _something_. nullable: true - expires_at: &79 + expires_at: &83 type: string format: date-time description: 'The time at which the announcement expires. This @@ -10860,7 +11017,7 @@ paths: it to an empty string.' example: '"2021-01-01T00:00:00.000-07:00"' nullable: true - user_dismissible: &80 + user_dismissible: &84 type: boolean description: Whether an announcement can be dismissed by the user. example: false @@ -10871,7 +11028,7 @@ paths: - expires_at - user_dismissible examples: - default: &81 + default: &85 summary: Announcement banner value: announcement: Very **important** announcement about _something_. @@ -10895,18 +11052,18 @@ paths: required: true content: application/json: - schema: &289 + schema: &296 title: Enterprise Announcement description: Enterprise global announcement type: object properties: - announcement: *78 - expires_at: *79 - user_dismissible: *80 + announcement: *82 + expires_at: *83 + user_dismissible: *84 required: - announcement examples: - default: *81 + default: *85 parameters: - *41 responses: @@ -10914,9 +11071,9 @@ paths: description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *81 + default: *85 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -11012,7 +11169,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-repositories-belonging-to-an-enterprise-owned-organization parameters: - *41 - - &83 + - &87 name: org description: The organization name. The name is not case sensitive. in: path @@ -11029,7 +11186,7 @@ paths: application/json: schema: type: array - items: &85 + items: &89 title: Accessible Repository description: A repository that may be made accessible to a GitHub App. @@ -11080,7 +11237,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#list-github-apps-installed-on-an-enterprise-owned-organization parameters: - *41 - - *83 + - *87 - *17 - *19 responses: @@ -11175,7 +11332,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#install-a-github-app-on-an-enterprise-owned-organization parameters: - *41 - - *83 + - *87 responses: '200': description: A GitHub App installation that was installed previously. @@ -11183,14 +11340,14 @@ paths: application/json: schema: *22 examples: - default: *84 + default: *88 '201': description: A GitHub App installation. content: application/json: schema: *22 examples: - default: *84 + default: *88 requestBody: required: true content: @@ -11258,7 +11415,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization parameters: - *41 - - *83 + - *87 - *23 responses: '204': @@ -11286,7 +11443,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation parameters: - *41 - - *83 + - *87 - *23 - *17 - *19 @@ -11298,7 +11455,7 @@ paths: application/json: schema: type: array - items: *85 + items: *89 examples: default: value: @@ -11327,7 +11484,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories parameters: - *41 - - *83 + - *87 - *23 requestBody: required: true @@ -11367,7 +11524,7 @@ paths: application/json: schema: *22 examples: - default: *84 + default: *88 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -11388,7 +11545,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#grant-repository-access-to-an-organization-installation parameters: - *41 - - *83 + - *87 - *23 responses: '200': @@ -11398,7 +11555,7 @@ paths: application/json: schema: type: array - items: *85 + items: *89 examples: default: value: @@ -11449,7 +11606,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#remove-repository-access-from-an-organization-installation parameters: - *41 - - *83 + - *87 - *23 responses: '200': @@ -11459,7 +11616,7 @@ paths: application/json: schema: type: array - items: *85 + items: *89 examples: default: value: @@ -11536,7 +11693,7 @@ paths: required: false schema: type: string - - &292 + - &299 name: include description: |- The event types to include: @@ -11554,7 +11711,7 @@ paths: - web - git - all - - &293 + - &300 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. @@ -11562,7 +11719,7 @@ paths: required: false schema: type: string - - &294 + - &301 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. @@ -11570,7 +11727,7 @@ paths: required: false schema: type: string - - &295 + - &302 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -11592,7 +11749,7 @@ paths: application/json: schema: type: array - items: &296 + items: &303 type: object properties: "@timestamp": @@ -11714,7 +11871,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &297 + default: &304 value: - "@timestamp": 1606929874512 action: team.add_member @@ -11893,7 +12050,7 @@ paths: vendor_specific: type: object oneOf: - - &89 + - &93 title: AzureBlobConfig description: Azure Blob Config for audit log streaming configuration. type: object @@ -11912,7 +12069,7 @@ paths: - key_id - encrypted_sas_url - container - - &90 + - &94 title: AzureHubConfig description: Azure Event Hubs Config for audit log streaming configuration. type: object @@ -11931,7 +12088,7 @@ paths: - name - encrypted_connstring - key_id - - &91 + - &95 title: AmazonS3OIDCConfig description: Amazon S3 OIDC Config for audit log streaming configuration. type: object @@ -11959,7 +12116,7 @@ paths: - bucket - key_id - region - - &92 + - &96 title: AmazonS3AccessKeysConfig description: Amazon S3 Access Keys Config for audit log streaming configuration. @@ -11993,7 +12150,7 @@ paths: - encrypted_secret_key - key_id - region - - &93 + - &97 title: SplunkConfig description: Splunk Config for Audit Log Stream Configuration type: object @@ -12021,7 +12178,7 @@ paths: - key_id - port - ssl_verify - - &94 + - &98 title: HecConfig description: Hec Config for Audit Log Stream Configuration type: object @@ -12053,7 +12210,7 @@ paths: - key_id - port - ssl_verify - - &95 + - &99 title: GoogleCloudConfig description: Google Cloud Config for audit log streaming configuration. type: object @@ -12071,7 +12228,7 @@ paths: - bucket - key_id - encrypted_json_credentials - - &96 + - &100 title: DatadogConfig description: Datadog Config for audit log streaming configuration. type: object @@ -12102,7 +12259,7 @@ paths: - stream_type - vendor_specific examples: - default: &97 + default: &101 value: enabled: false stream_type: Azure Event Hubs @@ -12116,7 +12273,7 @@ paths: description: The audit log stream configuration was created successfully. content: application/json: - schema: &86 + schema: &90 title: Get an audit log streaming configuration description: Get an audit log streaming configuration for an enterprise. type: object @@ -12147,7 +12304,7 @@ paths: - created_at - updated_at examples: - default: &87 + default: &91 value: id: 1 stream_type: Splunk @@ -12176,7 +12333,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#list-one-audit-log-streaming-configuration-via-a-stream-id parameters: - *41 - - &88 + - &92 name: stream_id description: The ID of the audit log stream configuration. in: path @@ -12188,9 +12345,9 @@ paths: description: Lists one audit log stream configuration via stream ID. content: application/json: - schema: *86 + schema: *90 examples: - default: *87 + default: *91 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -12210,7 +12367,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#update-an-existing-audit-log-stream-configuration parameters: - *41 - - *88 + - *92 requestBody: required: true content: @@ -12236,28 +12393,28 @@ paths: vendor_specific: type: object oneOf: - - *89 - - *90 - - *91 - - *92 - *93 - *94 - *95 - *96 + - *97 + - *98 + - *99 + - *100 required: - enabled - stream_type - vendor_specific examples: - default: *97 + default: *101 responses: '200': description: Successful update content: application/json: - schema: *86 + schema: *90 examples: - default: *87 + default: *91 '422': description: Validation error content: @@ -12288,7 +12445,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#delete-an-audit-log-streaming-configuration-for-an-enterprise parameters: - *41 - - *88 + - *92 responses: '204': description: The audit log stream configuration was deleted successfully. @@ -12315,13 +12472,13 @@ paths: subcategory: bypass-requests parameters: - *41 - - &98 + - &102 name: organization_name description: The name of the organization to filter on. in: query schema: type: string - - &99 + - &103 name: reviewer description: Filter bypass requests by the handle of the GitHub user who reviewed the bypass request. @@ -12329,7 +12486,7 @@ paths: required: false schema: type: string - - &100 + - &104 name: requester description: Filter bypass requests by the handle of the GitHub user who requested the bypass. @@ -12337,7 +12494,7 @@ paths: required: false schema: type: string - - &101 + - &105 name: time_period description: |- The time period to filter by. @@ -12353,7 +12510,7 @@ paths: - week - month default: day - - &102 + - &106 name: request_status description: The status of the bypass request to filter on. When specified, only requests with this status will be returned. @@ -12380,7 +12537,7 @@ paths: application/json: schema: type: array - items: &298 + items: &305 title: Push rule bypass request description: A bypass request made by a user asking to be exempted from a push rule in this repository. @@ -12497,7 +12654,7 @@ paths: type: array description: The responses to the bypass request. nullable: true - items: &103 + items: &107 title: Bypass response description: A response made by a delegated bypasser to a bypass request. @@ -12541,7 +12698,7 @@ paths: format: uri example: https://github.com/octo-org/smile/exemptions/1 examples: - default: &299 + default: &306 value: - id: 21 number: 42 @@ -12632,11 +12789,11 @@ paths: subcategory: delegated-bypass parameters: - *41 - - *98 - - *99 - - *100 - - *101 - *102 + - *103 + - *104 + - *105 + - *106 - *17 - *19 responses: @@ -12646,7 +12803,7 @@ paths: application/json: schema: type: array - items: &301 + items: &308 title: Secret scanning bypass request description: A bypass request made by a user asking to be exempted from push protection in this repository. @@ -12760,7 +12917,7 @@ paths: type: array description: The responses to the bypass request. nullable: true - items: *103 + items: *107 url: type: string format: uri @@ -12771,7 +12928,7 @@ paths: format: uri example: https://github.com/octo-org/smile/exemptions/1 examples: - default: &302 + default: &309 value: - id: 21 number: 42 @@ -12856,17 +13013,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *41 - - &307 + - &314 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: &107 + schema: &111 type: string description: The name of the tool used to generate the code scanning analysis. - - &308 + - &315 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 @@ -12874,22 +13031,22 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &108 + schema: &112 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. - - *104 - - *105 + - *108 + - *109 - *19 - *17 - - *106 + - *110 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: &309 + schema: &316 type: string description: State of a code scanning alert. enum: @@ -12914,42 +13071,42 @@ paths: application/json: schema: type: array - items: &310 + items: &317 type: object properties: - number: &123 + number: &127 type: integer description: The security alert number. readOnly: true - created_at: &130 + created_at: &134 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: &131 + updated_at: &135 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: &128 + url: &132 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &129 + html_url: &133 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &535 + instances_url: &537 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &109 + state: &113 type: string description: State of a code scanning alert. nullable: true @@ -12957,7 +13114,7 @@ paths: - open - dismissed - fixed - fixed_at: &133 + fixed_at: &137 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -12971,14 +13128,14 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: &132 + dismissed_at: &136 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissed_reason: &536 + dismissed_reason: &538 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -12987,13 +13144,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &537 + dismissed_comment: &539 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &538 + rule: &540 type: object properties: id: @@ -13046,25 +13203,25 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &539 + tool: &541 type: object properties: - name: *107 + name: *111 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *108 - most_recent_instance: &540 + guid: *112 + most_recent_instance: &542 type: object properties: - ref: &533 + ref: &535 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &550 + analysis_key: &552 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -13075,13 +13232,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &551 + category: &553 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: *109 + state: *113 commit_sha: type: string message: @@ -13120,11 +13277,11 @@ paths: - generated - test - library - repository: &115 + repository: &119 title: Simple Repository description: A GitHub repository. type: object - properties: &245 + properties: &252 id: type: integer format: int64 @@ -13351,7 +13508,7 @@ paths: format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. - required: &246 + required: &253 - archive_url - assignees_url - blobs_url @@ -13423,7 +13580,7 @@ paths: - most_recent_instance - repository examples: - default: &311 + default: &318 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -13652,9 +13809,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: *43 + Link: *47 '404': *6 - '503': &190 + '503': &195 description: Service unavailable content: application/json: @@ -13698,8 +13855,8 @@ paths: schema: type: integer default: 30 - - *104 - - *105 + - *108 + - *109 responses: '200': description: Response @@ -13707,7 +13864,7 @@ paths: application/json: schema: type: array - items: &110 + items: &114 type: object description: A code security configuration properties: @@ -14076,7 +14233,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &312 + code_scanning_options: &319 type: object description: Security Configuration feature options for code scanning nullable: true @@ -14093,7 +14250,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &113 + code_scanning_default_setup_options: &117 type: object description: Feature options for code scanning default setup nullable: true @@ -14210,9 +14367,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *110 + schema: *114 examples: - default: &111 + default: &115 value: id: 1325 target_type: enterprise @@ -14270,7 +14427,7 @@ paths: description: Response content: application/json: - schema: &314 + schema: &321 type: array description: A list of default code security configurations items: @@ -14284,9 +14441,9 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *110 + configuration: *114 examples: - default: &315 + default: &322 value: - default_for_new_repos: public configuration: @@ -14375,7 +14532,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise parameters: - *41 - - &112 + - &116 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -14387,9 +14544,9 @@ paths: description: Response content: application/json: - schema: *110 + schema: *114 examples: - default: *111 + default: *115 '304': *37 '403': *29 '404': *6 @@ -14414,7 +14571,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise parameters: - *41 - - *112 + - *116 requestBody: required: true content: @@ -14493,7 +14650,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *113 + code_scanning_default_setup_options: *117 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -14581,13 +14738,13 @@ paths: description: Response content: application/json: - schema: *110 + schema: *114 examples: - default: *111 + default: *115 '304': *37 '403': *29 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14611,14 +14768,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise parameters: - *41 - - *112 + - *116 responses: - '204': &150 + '204': &154 description: A header with no content is returned. '400': *14 '403': *29 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14643,7 +14800,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories parameters: - *41 - - *112 + - *116 requestBody: required: true content: @@ -14670,7 +14827,7 @@ paths: '202': *39 '403': *29 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14695,7 +14852,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise parameters: - *41 - - *112 + - *116 requestBody: required: true content: @@ -14735,12 +14892,12 @@ paths: - none - private_and_internal - public - configuration: *110 + configuration: *114 examples: default: value: default_for_new_repos: all - configuration: &313 + configuration: &320 value: id: 1325 target_type: organization @@ -14797,7 +14954,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration parameters: - *41 - - *112 + - *116 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -14806,8 +14963,8 @@ paths: schema: type: integer default: 30 - - *104 - - *105 + - *108 + - *109 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -14825,7 +14982,7 @@ paths: application/json: schema: type: array - items: &316 + items: &323 type: object description: Repositories associated with a code security configuration and attachment status @@ -14843,13 +15000,13 @@ paths: - failed - updating - removed_by_enterprise - repository: *115 + repository: *119 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: &317 + repository: &324 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -15257,7 +15414,7 @@ paths: visual_studio_subscription_email: '' total_user_accounts: 1 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -15314,7 +15471,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &141 + items: &145 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -15331,14 +15488,14 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *116 - required: *117 + properties: *120 + required: *121 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &303 + - &310 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -15413,7 +15570,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &373 + properties: &380 id: description: Unique identifier of the team type: integer @@ -15485,7 +15642,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &374 + required: &381 - id - node_id - url @@ -15511,7 +15668,7 @@ paths: - slug - parent - type - - &140 + - &144 title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -15621,7 +15778,7 @@ paths: - created_at additionalProperties: false examples: - default: &142 + default: &146 value: total_seats: 2 seats: @@ -15691,7 +15848,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 '500': *40 '401': *25 '403': *29 @@ -16073,7 +16230,7 @@ paths: application/json: schema: type: array - items: &202 + items: &207 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -16380,7 +16537,7 @@ paths: - date additionalProperties: true examples: - default: &203 + default: &208 value: - date: '2024-06-24' total_active_users: 24 @@ -16482,7 +16639,7 @@ paths: '500': *40 '403': *29 '404': *6 - '422': &204 + '422': &209 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -16512,7 +16669,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day parameters: - *41 - - &118 + - &122 name: day description: The day to request data for, in `YYYY-MM-DD` format. in: query @@ -16526,7 +16683,7 @@ paths: description: Response content: application/json: - schema: &119 + schema: &123 type: object title: Copilot Metrics 1 Day Report description: Links to download the Copilot usage metrics report for @@ -16547,7 +16704,7 @@ paths: - download_links - report_day examples: - default: &120 + default: &124 value: download_links: - https://example.com/copilot-usage-report-1.json @@ -16585,7 +16742,7 @@ paths: description: Response content: application/json: - schema: &121 + schema: &125 type: object title: Copilot Metrics 28 Day Report description: Links to download the latest Copilot usage metrics report @@ -16613,7 +16770,7 @@ paths: - report_start_day - report_end_day examples: - default: &122 + default: &126 value: download_links: - https://example.com/copilot-usage-report-1.json @@ -16647,15 +16804,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day parameters: - *41 - - *118 + - *122 responses: '200': description: Response content: application/json: - schema: *119 + schema: *123 examples: - default: *120 + default: *124 '500': *40 '403': *29 '404': *6 @@ -16688,9 +16845,9 @@ paths: description: Response content: application/json: - schema: *121 + schema: *125 examples: - default: *122 + default: *126 '500': *40 '403': *29 '404': *6 @@ -16718,7 +16875,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *41 - - &323 + - &330 name: state in: query description: |- @@ -16727,7 +16884,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &324 + - &331 name: severity in: query description: |- @@ -16736,7 +16893,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &325 + - &332 name: ecosystem in: query description: |- @@ -16745,14 +16902,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &326 + - &333 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 - - &327 + - &334 name: epss_percentage in: query description: |- @@ -16764,7 +16921,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 - - &590 + - &592 name: has in: query description: |- @@ -16778,7 +16935,7 @@ paths: type: string enum: - patch - - &328 + - &335 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -16788,7 +16945,7 @@ paths: enum: - development - runtime - - &329 + - &336 name: sort in: query description: |- @@ -16803,9 +16960,9 @@ paths: - updated - epss_percentage default: created - - *106 - - *104 - - *105 + - *110 + - *108 + - *109 - *17 responses: '200': @@ -16814,11 +16971,11 @@ paths: application/json: schema: type: array - items: &330 + items: &337 type: object description: A Dependabot alert. properties: - number: *123 + number: *127 state: type: string description: The state of the Dependabot alert. @@ -16833,7 +16990,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: &124 + package: &128 type: object description: Details for the vulnerable package. readOnly: true @@ -16877,7 +17034,7 @@ paths: - unknown - direct - transitive - security_advisory: &591 + security_advisory: &593 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -16907,13 +17064,13 @@ paths: description: Vulnerable version range information for the advisory. readOnly: true - items: &127 + items: &131 type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: - package: *124 + package: *128 severity: type: string description: The severity of the vulnerability. @@ -16979,8 +17136,8 @@ paths: - score - vector_string additionalProperties: false - cvss_severities: *125 - epss: *126 + cvss_severities: *129 + epss: *130 cwes: type: array description: Details for the advisory pertaining to Common @@ -17079,12 +17236,12 @@ paths: - updated_at - withdrawn_at additionalProperties: false - security_vulnerability: *127 - url: *128 - html_url: *129 - created_at: *130 - updated_at: *131 - dismissed_at: *132 + security_vulnerability: *131 + url: *132 + html_url: *133 + created_at: *134 + updated_at: *135 + dismissed_at: *136 dismissed_by: title: Simple User description: A GitHub user. @@ -17108,15 +17265,15 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *133 - auto_dismissed_at: &592 + fixed_at: *137 + auto_dismissed_at: &594 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - repository: *115 + repository: *119 required: - number - state @@ -17135,7 +17292,7 @@ paths: - repository additionalProperties: false examples: - default: &331 + default: &338 value: - number: 2 state: dismissed @@ -17498,7 +17655,7 @@ paths: roles: type: array description: The list of enterprise roles available to the enterprise. - items: &139 + items: &143 title: Enterprise Role description: Enterprise custom roles type: object @@ -17532,8 +17689,8 @@ paths: title: Enterprise description: An enterprise on GitHub. type: object - properties: *134 - required: *135 + properties: *138 + required: *139 nullable: true created_at: description: The date and time the role was created. @@ -17623,7 +17780,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-team parameters: - *41 - - &136 + - &140 name: team_slug description: The slug of the enterprise team name. in: path @@ -17663,8 +17820,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-a-team parameters: - *41 - - *136 - - &137 + - *140 + - &141 name: role_id description: The unique identifier of the role. in: path @@ -17703,8 +17860,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-an-enterprise-role-from-a-team parameters: - *41 - - *136 - - *137 + - *140 + - *141 responses: '204': description: Response @@ -17738,7 +17895,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-all-enterprise-roles-from-a-user parameters: - *41 - - &138 + - &142 name: username description: The handle for the GitHub user account. in: path @@ -17778,8 +17935,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#assign-an-enterprise-role-to-an-enterprise-user parameters: - *41 - - *138 - - *137 + - *142 + - *141 responses: '204': description: Response @@ -17812,8 +17969,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#remove-enterprise-user-role-assignment parameters: - *41 - - *138 - - *137 + - *142 + - *141 responses: '204': description: Response @@ -17847,13 +18004,13 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#get-an-enterprise-role parameters: - *41 - - *137 + - *141 responses: '200': description: Response content: application/json: - schema: *139 + schema: *143 examples: default: value: @@ -17904,7 +18061,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#list-teams-that-are-assigned-to-an-enterprise-role parameters: - *41 - - *137 + - *141 - *17 - *19 responses: @@ -17914,9 +18071,9 @@ paths: application/json: schema: type: array - items: *140 + items: *144 examples: - default: &205 + default: &210 value: - id: 1 name: Justice League @@ -17955,7 +18112,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/enterprise-roles#list-users-that-are-assigned-to-an-enterprise-role parameters: - *41 - - *137 + - *141 - *17 - *19 responses: @@ -17987,7 +18144,7 @@ paths: description: Enterprise Team the user has gotten the role through type: array - items: *140 + items: *144 examples: default: value: @@ -18049,7 +18206,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 '403': *29 '404': *6 x-github: @@ -18146,7 +18303,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-an-enterprise-user parameters: - *41 - - *138 + - *142 responses: '200': description: The user's GitHub Copilot seat details, including usage. @@ -18162,9 +18319,9 @@ paths: teams or multiple organizations are only counted once. seats: type: array - items: *141 + items: *145 examples: - default: *142 + default: *146 '500': *40 '401': *25 '403': *29 @@ -18207,7 +18364,7 @@ paths: type: integer network_configurations: type: array - items: &143 + items: &147 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -18247,7 +18404,7 @@ paths: - name - created_on examples: - default: &433 + default: &441 value: total_count: 2 network_configurations: @@ -18266,7 +18423,7 @@ paths: - 6789ABDCEF12345 created_on: '2023-04-26T15:23:37Z' headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -18325,9 +18482,9 @@ paths: description: Response content: application/json: - schema: *143 + schema: *147 examples: - default: &144 + default: &148 value: id: 123456789ABCDEF name: My network configuration @@ -18354,7 +18511,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-configuration-for-an-enterprise parameters: - *41 - - &145 + - &149 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -18366,11 +18523,11 @@ paths: description: Response content: application/json: - schema: *143 + schema: *147 examples: - default: *144 + default: *148 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -18388,7 +18545,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#update-a-hosted-compute-network-configuration-for-an-enterprise parameters: - *41 - - *145 + - *149 requestBody: required: true content: @@ -18427,9 +18584,9 @@ paths: description: Response content: application/json: - schema: *143 + schema: *147 examples: - default: *144 + default: *148 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -18447,7 +18604,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#delete-a-hosted-compute-network-configuration-from-an-enterprise parameters: - *41 - - *145 + - *149 responses: '204': description: Response @@ -18470,7 +18627,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *41 - - &434 + - &442 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -18482,7 +18639,7 @@ paths: description: Response content: application/json: - schema: &435 + schema: &443 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -18516,7 +18673,7 @@ paths: - subnet_id - region examples: - default: &436 + default: &444 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -18524,7 +18681,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: *43 + Link: *47 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -18555,7 +18712,7 @@ paths: application/json: schema: type: array - items: &146 + items: &150 title: Custom Property for Organization description: Custom property defined for an organization allOf: @@ -18622,7 +18779,7 @@ paths: - property_name - value_type examples: - default: &147 + default: &151 value: properties: - property_name: environment @@ -18683,13 +18840,13 @@ paths: type: array description: The array of organization custom properties to create or update. - items: *146 + items: *150 minItems: 1 maxItems: 100 required: - properties examples: - default: *147 + default: *151 responses: '200': description: Response @@ -18697,9 +18854,9 @@ paths: application/json: schema: type: array - items: *146 + items: *150 examples: - default: *147 + default: *151 '403': *29 '404': *6 '422': *7 @@ -18726,7 +18883,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#get-an-organization-custom-property-definition-from-an-enterprise parameters: - *41 - - &148 + - &152 name: custom_property_name description: The custom property name in: path @@ -18738,9 +18895,9 @@ paths: description: Response content: application/json: - schema: *146 + schema: *150 examples: - default: &149 + default: &153 value: property_name: environment url: https://api.github.com/enterprises/github/org-properties/schema/environment @@ -18777,7 +18934,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#create-or-update-an-organization-custom-property-definition-on-an-enterprise parameters: - *41 - - *148 + - *152 requestBody: required: true content: @@ -18845,9 +19002,9 @@ paths: description: Response content: application/json: - schema: *146 + schema: *150 examples: - default: *149 + default: *153 '403': *29 '404': *6 '422': *7 @@ -18873,9 +19030,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties-for-orgs#remove-an-organization-custom-property-definition-from-an-enterprise parameters: - *41 - - *148 + - *152 responses: - '204': *150 + '204': *154 '403': *29 '404': *6 '422': *7 @@ -18924,7 +19081,7 @@ paths: example: Hello-World properties: type: array - items: &151 + items: &155 title: Custom Property Value description: Custom property name and associated value type: object @@ -18961,7 +19118,7 @@ paths: - property_name: team value: octocat headers: - Link: *43 + Link: *47 '403': *29 '404': *6 x-github: @@ -19007,7 +19164,7 @@ paths: type: array description: List of custom property names and associated values to apply to the organizations. - items: *151 + items: *155 required: - organization_logins - properties @@ -19057,7 +19214,7 @@ paths: application/json: schema: type: array - items: &152 + items: &156 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -19121,7 +19278,7 @@ paths: - property_name - value_type examples: - default: &153 + default: &157 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -19178,7 +19335,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *152 + items: *156 minItems: 1 maxItems: 100 required: @@ -19208,9 +19365,9 @@ paths: application/json: schema: type: array - items: *152 + items: *156 examples: - default: *153 + default: *157 '403': *29 '404': *6 x-github: @@ -19233,16 +19390,16 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#promote-a-custom-property-to-an-enterprise parameters: - *41 - - *83 - - *148 + - *87 + - *152 responses: '200': description: Response content: application/json: - schema: *152 + schema: *156 examples: - default: &154 + default: &158 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -19275,15 +19432,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise parameters: - *41 - - *148 + - *152 responses: '200': description: Response content: application/json: - schema: *152 + schema: *156 examples: - default: *154 + default: *158 '403': *29 '404': *6 x-github: @@ -19305,12 +19462,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise parameters: - *41 - - *148 + - *152 requestBody: required: true content: application/json: - schema: &405 + schema: &412 title: Custom Property Set Payload description: Custom property set payload type: object @@ -19372,9 +19529,9 @@ paths: description: Response content: application/json: - schema: *152 + schema: *156 examples: - default: *154 + default: *158 '403': *29 '404': *6 x-github: @@ -19396,9 +19553,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise parameters: - *41 - - *148 + - *152 responses: - '204': *150 + '204': *154 '403': *29 '404': *6 x-github: @@ -19438,7 +19595,7 @@ paths: - push - repository default: branch - enforcement: &163 + enforcement: &167 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights @@ -19451,7 +19608,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &164 + items: &168 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -19492,7 +19649,7 @@ paths: - pull_request - exempt default: always - conditions: &187 + conditions: &192 title: Enterprise ruleset conditions type: object description: Conditions for an enterprise ruleset. The conditions @@ -19506,7 +19663,7 @@ paths: description: Conditions to target organizations by name and all repositories allOf: - - &155 + - &159 title: Repository ruleset conditions for organization names type: object description: Parameters for an organization name condition @@ -19532,7 +19689,7 @@ paths: type: string required: - organization_name - - &158 + - &162 title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -19561,7 +19718,7 @@ paths: is prevented. required: - repository_name - - &157 + - &161 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name condition @@ -19589,8 +19746,8 @@ paths: description: Conditions to target organizations by name and repositories by property allOf: - - *155 - - &160 + - *159 + - &164 title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -19603,7 +19760,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &156 + items: &160 title: Repository ruleset property targeting definition type: object description: Parameters for a targeting a repository @@ -19634,16 +19791,16 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *156 + items: *160 required: - repository_property - - *157 + - *161 - type: object title: organization_id_and_repository_name description: Conditions to target organizations by id and all repositories allOf: - - &159 + - &163 title: Repository ruleset conditions for organization IDs type: object description: Parameters for an organization ID condition @@ -19660,22 +19817,22 @@ paths: type: integer required: - organization_id - - *158 - - *157 + - *162 + - *161 - type: object title: organization_id_and_repository_property description: Conditions to target organization by id and repositories by property allOf: - - *159 - - *160 - - *157 + - *163 + - *164 + - *161 - type: object title: organization_property_and_repository_name description: Conditions to target organizations by property and all repositories allOf: - - &162 + - &166 title: Repository ruleset conditions for organization properties type: object description: Parameters for a organization property condition @@ -19688,7 +19845,7 @@ paths: description: The organization properties and values to include. All of these properties must match for the condition to pass. - items: &161 + items: &165 title: Repository ruleset property targeting definition type: object description: Parameters for a targeting a organization @@ -19712,28 +19869,28 @@ paths: description: The organization properties and values to exclude. The condition will not pass if any of these properties match. - items: *161 + items: *165 required: - organization_property - - *158 - - *157 + - *162 + - *161 - type: object title: organization_property_and_repository_property description: Conditions to target organizations by property and repositories by property allOf: - - *162 - - *160 - - *157 + - *166 + - *164 + - *161 rules: type: array description: An array of rules within the ruleset. - items: &188 + items: &193 title: Repository Rule type: object description: A repository rule. oneOf: - - &165 + - &169 title: creation description: Only allow users with bypass permission to create matching refs. @@ -19745,7 +19902,7 @@ paths: type: string enum: - creation - - &166 + - &170 title: update description: Only allow users with bypass permission to update matching refs. @@ -19766,7 +19923,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &167 + - &171 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -19778,7 +19935,7 @@ paths: type: string enum: - deletion - - &168 + - &172 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -19790,7 +19947,7 @@ paths: type: string enum: - required_linear_history - - &169 + - &173 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches @@ -19814,7 +19971,7 @@ paths: type: string required: - required_deployment_environments - - &170 + - &174 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -19826,7 +19983,7 @@ paths: type: string enum: - required_signatures - - &171 + - &175 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. @@ -19934,7 +20091,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &172 + - &176 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed @@ -19981,7 +20138,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &173 + - &177 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -19993,7 +20150,7 @@ paths: type: string enum: - non_fast_forward - - &174 + - &178 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -20029,43 +20186,43 @@ paths: required: - operator - pattern - - &175 - 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 - - &176 + - &179 + 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 + - &180 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -20101,7 +20258,7 @@ paths: required: - operator - pattern - - &177 + - &181 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -20137,7 +20294,7 @@ paths: required: - operator - pattern - - &178 + - &182 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -20173,7 +20330,7 @@ paths: required: - operator - pattern - - &179 + - &183 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. @@ -20197,7 +20354,7 @@ paths: type: string required: - restricted_file_paths - - &180 + - &184 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit @@ -20221,7 +20378,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &181 + - &185 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -20244,7 +20401,7 @@ paths: type: string required: - restricted_file_extensions - - &182 + - &186 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. @@ -20268,7 +20425,7 @@ paths: maximum: 100 required: - max_file_size - - &183 + - &187 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -20317,7 +20474,7 @@ paths: - repository_id required: - workflows - - &184 + - &188 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning @@ -20377,6 +20534,29 @@ paths: - tool required: - code_scanning_tools + - &189 + 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. required: - name - enforcement @@ -20403,7 +20583,7 @@ paths: description: Response content: application/json: - schema: &185 + schema: &190 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -20438,11 +20618,11 @@ paths: source: type: string description: The name of the source - enforcement: *163 + enforcement: *167 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *164 + items: *168 current_user_can_bypass: type: string description: |- @@ -20474,8 +20654,8 @@ paths: conditions: nullable: true anyOf: - - *157 - - &411 + - *161 + - &418 title: Organization ruleset conditions type: object description: |- @@ -20489,14 +20669,14 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *157 - - *158 + - *161 + - *162 - type: object title: repository_id_and_ref_name description: Conditions to target repositories by id and refs by name allOf: - - *157 + - *161 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -20518,20 +20698,20 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *157 - - *160 + - *161 + - *164 rules: type: array - items: &716 + items: &717 title: Repository Rule type: object description: A repository rule. oneOf: - - *165 - - *166 - - *167 - - *168 - - &713 + - *169 + - *170 + - *171 + - *172 + - &715 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -20609,10 +20789,6 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - *169 - - *170 - - *171 - - *172 - *173 - *174 - *175 @@ -20625,29 +20801,11 @@ paths: - *182 - *183 - *184 - - &714 - 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. + - *185 + - *186 + - *187 + - *188 + - *189 created_at: type: string format: date-time @@ -20655,7 +20813,7 @@ paths: type: string format: date-time examples: - default: &186 + default: &191 value: id: 21 name: super cool ruleset @@ -20714,9 +20872,9 @@ paths: description: Response content: application/json: - schema: *185 + schema: *190 examples: - default: *186 + default: *191 '404': *6 '500': *40 x-github: @@ -20760,16 +20918,16 @@ paths: - tag - push - repository - enforcement: *163 + enforcement: *167 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *164 - conditions: *187 + items: *168 + conditions: *192 rules: description: An array of rules within the ruleset. type: array - items: *188 + items: *193 examples: default: value: @@ -20793,9 +20951,9 @@ paths: description: Response content: application/json: - schema: *185 + schema: *190 examples: - default: *186 + default: *191 '404': *6 '500': *40 x-github: @@ -20857,7 +21015,7 @@ paths: application/json: schema: type: array - items: &189 + items: &194 title: Ruleset version type: object description: The historical version of a ruleset @@ -20881,7 +21039,7 @@ paths: type: string format: date-time examples: - default: &414 + default: &421 value: - version_id: 3 actor: @@ -20934,9 +21092,9 @@ paths: description: Response content: application/json: - schema: &415 + schema: &422 allOf: - - *189 + - *194 - type: object required: - state @@ -20989,7 +21147,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *41 - - &416 + - &423 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -21000,7 +21158,7 @@ paths: enum: - open - resolved - - &417 + - &424 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -21010,7 +21168,7 @@ paths: required: false schema: type: string - - &418 + - &425 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -21019,7 +21177,26 @@ paths: required: false schema: type: string - - &419 + - &426 + 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 + - &427 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. @@ -21031,11 +21208,11 @@ paths: - created - updated default: created - - *106 + - *110 - *17 - - *104 - - *105 - - &420 + - *108 + - *109 + - &428 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -21044,7 +21221,7 @@ paths: required: false schema: type: string - - &421 + - &429 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -21053,7 +21230,7 @@ paths: schema: type: boolean default: false - - &422 + - &430 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -21062,7 +21239,7 @@ paths: schema: type: boolean default: false - - &423 + - &431 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -21078,11 +21255,11 @@ paths: application/json: schema: type: array - items: &424 + items: &432 type: object properties: - number: *123 - created_at: *130 + number: *127 + created_at: *134 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -21090,21 +21267,21 @@ paths: format: date-time readOnly: true nullable: true - url: *128 - html_url: *129 + url: *132 + html_url: *133 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &728 + state: &729 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: &729 + resolution: &730 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -21138,7 +21315,7 @@ paths: secret: type: string description: The secret that was detected. - repository: *115 + repository: *119 push_protection_bypassed: type: boolean description: Whether push protection was bypassed for the detected @@ -21211,8 +21388,8 @@ paths: pull request. ' - oneOf: &730 - - &732 + oneOf: &731 + - &733 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -21264,7 +21441,7 @@ paths: - blob_url - commit_sha - commit_url - - &733 + - &734 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. @@ -21319,7 +21496,7 @@ paths: - page_url - commit_sha - commit_url - - &734 + - &735 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -21333,7 +21510,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &735 + - &736 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -21347,7 +21524,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &736 + - &737 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -21361,7 +21538,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &737 + - &738 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -21375,7 +21552,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &738 + - &739 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -21389,7 +21566,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &739 + - &740 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -21403,7 +21580,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &740 + - &741 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. @@ -21417,7 +21594,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &741 + - &742 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. @@ -21431,7 +21608,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &742 + - &743 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. @@ -21445,7 +21622,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &743 + - &744 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. @@ -21459,7 +21636,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &744 + - &745 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. @@ -21486,7 +21663,7 @@ paths: required: *21 nullable: true examples: - default: &425 + default: &433 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -21662,9 +21839,9 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -21695,13 +21872,13 @@ paths: description: Response content: application/json: - schema: &426 + schema: &434 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. type: object properties: - pattern_config_version: &192 + pattern_config_version: &197 type: string description: The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate @@ -21710,7 +21887,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &191 + items: &196 type: object properties: token_type: @@ -21776,9 +21953,9 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *191 + items: *196 examples: - default: &427 + default: &435 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -21833,7 +22010,7 @@ paths: schema: type: object properties: - pattern_config_version: *192 + pattern_config_version: *197 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -21859,7 +22036,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *192 + custom_pattern_version: *197 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -21895,7 +22072,7 @@ paths: '400': *14 '403': *29 '404': *6 - '409': *114 + '409': *118 '422': *15 "/enterprises/{enterprise}/settings/billing/advanced-security": get: @@ -21914,7 +22091,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/licensing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *41 - - &430 + - &438 name: advanced_security_product in: query description: | @@ -21934,7 +22111,7 @@ paths: description: Success content: application/json: - schema: &431 + schema: &439 type: object properties: total_advanced_security_committers: @@ -21989,7 +22166,7 @@ paths: required: - repositories examples: - default: &432 + default: &440 value: total_advanced_security_committers: 2 total_count: 2 @@ -22032,6 +22209,24 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#get-all-budgets parameters: - *41 + - *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 @@ -22107,6 +22302,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: @@ -22358,7 +22557,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#get-a-budget-by-id parameters: - *41 - - &193 + - &198 name: budget_id description: The ID corresponding to the budget. in: path @@ -22452,7 +22651,7 @@ paths: '404': *6 '403': *29 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -22615,7 +22814,19 @@ paths: update-budget: value: message: Budget successfully updated. - budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b + 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': *25 '403': *29 @@ -22675,7 +22886,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#delete-a-budget parameters: - *41 - - *193 + - *198 responses: '200': description: Response when deleting a budget @@ -22702,7 +22913,7 @@ paths: '404': *6 '403': *29 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -22801,7 +23012,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -22930,7 +23141,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#get-a-cost-center-by-id parameters: - *41 - - &196 + - &201 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -22942,7 +23153,7 @@ paths: description: Response when getting a cost center content: application/json: - schema: &194 + schema: &199 type: object properties: id: @@ -22981,7 +23192,7 @@ paths: - name - resources examples: - default: &195 + default: &200 value: id: 2eeb8ffe-6903-11ee-8c99-0242ac120002 name: Cost Center Name @@ -22995,7 +23206,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -23045,15 +23256,15 @@ paths: description: Response when updating a cost center content: application/json: - schema: *194 + schema: *199 examples: - default: *195 + default: *200 '400': *14 '403': *29 '404': *6 - '409': *114 + '409': *118 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -23071,7 +23282,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#delete-a-cost-center parameters: - *41 - - *196 + - *201 responses: '200': description: Response when deleting a cost center @@ -23110,7 +23321,7 @@ paths: '404': *6 '403': *29 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -23131,7 +23342,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#add-resources-to-a-cost-center parameters: - *41 - - *196 + - *201 requestBody: required: true content: @@ -23201,9 +23412,9 @@ paths: previous_cost_center: yet-another-cost-center '400': *14 '403': *29 - '409': *114 + '409': *118 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -23223,7 +23434,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/cost-centers#remove-resources-from-a-cost-center parameters: - *41 - - *196 + - *201 requestBody: required: true content: @@ -23270,7 +23481,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -23291,7 +23502,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/usage#get-billing-premium-request-usage-report-for-an-enterprise parameters: - *41 - - &197 + - &202 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, @@ -23300,7 +23511,7 @@ paths: required: false schema: type: integer - - &199 + - &204 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 @@ -23309,7 +23520,7 @@ paths: required: false schema: type: integer - - &198 + - &203 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 @@ -23318,7 +23529,7 @@ paths: required: false schema: type: integer - - &200 + - &205 name: organization description: The organization name to query usage for. The name is not case sensitive. @@ -23338,7 +23549,7 @@ paths: required: false schema: type: string - - &201 + - &206 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -23477,7 +23688,7 @@ paths: '403': *29 '404': *6 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -23498,7 +23709,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/usage#get-billing-usage-report-for-an-enterprise parameters: - *41 - - *197 + - *202 - 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 @@ -23507,7 +23718,7 @@ paths: required: false schema: type: integer - - *198 + - *203 - name: cost_center_id description: The ID corresponding to a cost center. The default value is no cost center. @@ -23590,7 +23801,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -23614,17 +23825,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/usage#get-billing-usage-summary-for-an-enterprise parameters: - *41 - - *197 - - *199 - - *198 - - *200 + - *202 + - *204 + - *203 + - *205 - name: repository description: The repository name to query for usage in the format owner/repository. in: query required: false schema: type: string - - *201 + - *206 - name: sku description: The SKU to query for usage. in: query @@ -23757,7 +23968,7 @@ paths: '400': *14 '403': *29 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -23791,7 +24002,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team parameters: - *41 - - *136 + - *140 - 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`). @@ -23823,13 +24034,13 @@ paths: application/json: schema: type: array - items: *202 + items: *207 examples: - default: *203 + default: *208 '500': *40 '403': *29 '404': *6 - '422': *204 + '422': *209 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -23856,11 +24067,11 @@ paths: application/json: schema: type: array - items: *140 + items: *144 examples: - default: *205 + default: *210 headers: - Link: *43 + Link: *47 '403': *29 x-github: githubCloudOnly: false @@ -23933,9 +24144,9 @@ paths: description: Response content: application/json: - schema: *140 + schema: *144 examples: - default: *205 + default: *210 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23953,7 +24164,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *41 - - &206 + - &211 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -23972,7 +24183,7 @@ paths: type: array items: *4 examples: - default: &207 + default: &212 value: - login: octocat id: 1 @@ -23993,7 +24204,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24011,7 +24222,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *41 - - *206 + - *211 requestBody: required: true content: @@ -24042,7 +24253,7 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24060,7 +24271,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *41 - - *206 + - *211 requestBody: required: true content: @@ -24091,7 +24302,7 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24109,8 +24320,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *41 - - *206 - - *138 + - *211 + - *142 responses: '200': description: User is a member of the enterprise team. @@ -24118,7 +24329,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &208 + exampleKey1: &213 value: login: octocat id: 1 @@ -24154,8 +24365,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *41 - - *206 - - *138 + - *211 + - *142 responses: '201': description: Successfully added team member @@ -24163,7 +24374,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *208 + exampleKey1: *213 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24181,8 +24392,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *41 - - *206 - - *138 + - *211 + - *142 responses: '204': description: Response @@ -24204,7 +24415,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments parameters: - *41 - - *206 + - *211 - *17 - *19 responses: @@ -24214,9 +24425,9 @@ paths: application/json: schema: type: array - items: *69 + items: *73 examples: - default: &209 + default: &214 value: login: github id: 1 @@ -24247,7 +24458,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments parameters: - *41 - - *206 + - *211 requestBody: required: true content: @@ -24275,9 +24486,9 @@ paths: application/json: schema: type: array - items: *69 + items: *73 examples: - default: &244 + default: &249 value: - login: github id: 1 @@ -24308,7 +24519,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments parameters: - *41 - - *206 + - *211 requestBody: required: true content: @@ -24349,16 +24560,16 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment parameters: - *41 - - *206 - - *83 + - *211 + - *87 responses: '200': description: The team is assigned to the organization content: application/json: - schema: *69 + schema: *73 examples: - default: *209 + default: *214 '404': description: The team is not assigned to the organization x-github: @@ -24377,16 +24588,16 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment parameters: - *41 - - *206 - - *83 + - *211 + - *87 responses: '201': description: Successfully assigned the enterprise team to the organization. content: application/json: - schema: *69 + schema: *73 examples: - default: *209 + default: *214 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24403,8 +24614,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment parameters: - *41 - - *206 - - *83 + - *211 + - *87 responses: '204': description: Successfully unassigned the enterprise team from the organization. @@ -24428,7 +24639,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *41 - - &210 + - &215 name: team_slug description: The slug of the team name. in: path @@ -24440,11 +24651,11 @@ paths: description: Response content: application/json: - schema: *140 + schema: *144 examples: - default: *205 + default: *210 headers: - Link: *43 + Link: *47 '403': *29 x-github: githubCloudOnly: false @@ -24462,7 +24673,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *41 - - *210 + - *215 requestBody: required: true content: @@ -24517,11 +24728,11 @@ paths: description: Response content: application/json: - schema: *140 + schema: *144 examples: - default: *205 + default: *210 headers: - Link: *43 + Link: *47 '403': *29 x-github: githubCloudOnly: false @@ -24542,7 +24753,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *41 - - *210 + - *215 responses: '204': description: Response @@ -24641,7 +24852,7 @@ paths: application/json: schema: type: array - items: &239 + items: &244 title: Event description: Event type: object @@ -24651,7 +24862,7 @@ paths: type: type: string nullable: true - actor: &211 + actor: &216 title: Actor description: Actor type: object @@ -24691,18 +24902,18 @@ paths: - id - name - url - org: *211 + org: *216 payload: type: object properties: action: type: string - issue: &227 + issue: &232 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &650 + properties: &652 id: type: integer format: int64 @@ -24814,7 +25025,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &395 + properties: &402 url: type: string format: uri @@ -24884,7 +25095,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &396 + required: &403 - closed_issues - creator - description @@ -24963,7 +25174,7 @@ paths: timeline_url: type: string format: uri - type: &360 + type: &367 title: Issue Type description: The type of issue. type: object @@ -25012,7 +25223,7 @@ paths: - node_id - name - description - repository: *74 + repository: *78 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -25022,9 +25233,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 - author_association: &214 + properties: *217 + required: *218 + author_association: &219 title: author_association type: string example: OWNER @@ -25038,7 +25249,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &215 + reactions: &220 title: Reaction Rollup type: object properties: @@ -25074,7 +25285,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &788 + sub_issues_summary: &789 title: Sub-issues Summary type: object properties: @@ -25094,7 +25305,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &789 + issue_dependencies_summary: &790 title: Issue Dependencies Summary type: object properties: @@ -25113,7 +25324,7 @@ paths: - total_blocking issue_field_values: type: array - items: &790 + items: &791 title: Issue Field Value description: A value assigned to an issue field type: object @@ -25173,7 +25384,7 @@ paths: - node_id - data_type - value - required: &651 + required: &653 - assignee - closed_at - comments @@ -25194,7 +25405,7 @@ paths: - user - created_at - updated_at - comment: &648 + comment: &650 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -25242,7 +25453,7 @@ paths: issue_url: type: string format: uri - author_association: *214 + author_association: *219 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -25252,9 +25463,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 - reactions: *215 + properties: *217 + required: *218 + reactions: *220 required: - id - node_id @@ -25340,7 +25551,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25421,7 +25632,7 @@ paths: _links: type: object properties: - timeline: &216 + timeline: &221 title: Link With Type description: Hypermedia Link with Type type: object @@ -25433,17 +25644,17 @@ paths: required: - href - type - user: *216 - security_advisories: *216 - current_user: *216 - current_user_public: *216 - current_user_actor: *216 - current_user_organization: *216 + user: *221 + security_advisories: *221 + current_user: *221 + current_user_public: *221 + current_user_actor: *221 + current_user_organization: *221 current_user_organizations: type: array - items: *216 - repository_discussions: *216 - repository_discussions_category: *216 + items: *221 + repository_discussions: *221 + repository_discussions_category: *221 required: - timeline - user @@ -25505,7 +25716,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *217 + - *222 - *17 - *19 responses: @@ -25515,7 +25726,7 @@ paths: application/json: schema: type: array - items: &218 + items: &223 title: Base Gist description: Base Gist type: object @@ -25614,7 +25825,7 @@ paths: - created_at - updated_at examples: - default: &219 + default: &224 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -25659,7 +25870,7 @@ paths: site_admin: false truncated: false headers: - Link: *43 + Link: *47 '304': *37 '403': *29 x-github: @@ -25735,7 +25946,7 @@ paths: description: Response content: application/json: - schema: &220 + schema: &225 title: Gist Simple description: Gist Simple type: object @@ -25752,7 +25963,7 @@ paths: url: type: string format: uri - user: &802 + user: &801 title: Public User description: Public User type: object @@ -26114,7 +26325,7 @@ paths: truncated: type: boolean examples: - default: &221 + default: &226 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -26218,7 +26429,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *217 + - *222 - *17 - *19 responses: @@ -26228,11 +26439,11 @@ paths: application/json: schema: type: array - items: *218 + items: *223 examples: - default: *219 + default: *224 headers: - Link: *43 + Link: *47 '422': *15 '304': *37 '403': *29 @@ -26252,7 +26463,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *217 + - *222 - *17 - *19 responses: @@ -26262,11 +26473,11 @@ paths: application/json: schema: type: array - items: *218 + items: *223 examples: - default: *219 + default: *224 headers: - Link: *43 + Link: *47 '401': *25 '304': *37 '403': *29 @@ -26292,7 +26503,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &222 + - &227 name: gist_id description: The unique identifier of the gist. in: path @@ -26304,10 +26515,10 @@ paths: description: Response content: application/json: - schema: *220 + schema: *225 examples: - default: *221 - '403': &225 + default: *226 + '403': &230 description: Forbidden Gist content: application/json: @@ -26355,7 +26566,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *222 + - *227 requestBody: required: true content: @@ -26415,9 +26626,9 @@ paths: description: Response content: application/json: - schema: *220 + schema: *225 examples: - updateGist: *221 + updateGist: *226 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -26575,7 +26786,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *222 + - *227 responses: '204': description: Response @@ -26604,7 +26815,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *222 + - *227 - *17 - *19 responses: @@ -26614,7 +26825,7 @@ paths: application/json: schema: type: array - items: &223 + items: &228 title: Gist Comment description: A comment made to a gist. type: object @@ -26649,7 +26860,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *214 + author_association: *219 required: - url - id @@ -26689,7 +26900,7 @@ paths: updated_at: '2011-04-18T23:23:56Z' author_association: COLLABORATOR headers: - Link: *43 + Link: *47 '304': *37 '404': *6 '403': *29 @@ -26714,7 +26925,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *222 + - *227 requestBody: required: true content: @@ -26739,9 +26950,9 @@ paths: description: Response content: application/json: - schema: *223 + schema: *228 examples: - default: &224 + default: &229 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -26799,8 +27010,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *222 - - &226 + - *227 + - &231 name: comment_id description: The unique identifier of the comment. in: path @@ -26813,12 +27024,12 @@ paths: description: Response content: application/json: - schema: *223 + schema: *228 examples: - default: *224 + default: *229 '304': *37 '404': *6 - '403': *225 + '403': *230 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -26840,8 +27051,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *222 - - *226 + - *227 + - *231 requestBody: required: true content: @@ -26866,9 +27077,9 @@ paths: description: Response content: application/json: - schema: *223 + schema: *228 examples: - default: *224 + default: *229 '404': *6 x-github: githubCloudOnly: false @@ -26885,8 +27096,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *222 - - *226 + - *227 + - *231 responses: '204': description: Response @@ -26909,7 +27120,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *222 + - *227 - *17 - *19 responses: @@ -27010,7 +27221,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *222 + - *227 - *17 - *19 responses: @@ -27020,7 +27231,7 @@ paths: application/json: schema: type: array - items: *220 + items: *225 examples: default: value: @@ -27066,7 +27277,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 '404': *6 '304': *37 '403': *29 @@ -27085,13 +27296,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *222 + - *227 responses: '201': description: Response content: application/json: - schema: *218 + schema: *223 examples: default: value: @@ -27162,7 +27373,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *222 + - *227 responses: '204': description: Response if gist is starred @@ -27192,7 +27403,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *222 + - *227 responses: '204': description: Response @@ -27214,7 +27425,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *222 + - *227 responses: '204': description: Response @@ -27243,7 +27454,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *222 + - *227 - name: sha in: path required: true @@ -27254,9 +27465,9 @@ paths: description: Response content: application/json: - schema: *220 + schema: *225 examples: - default: *221 + default: *226 '422': *15 '404': *6 '403': *29 @@ -27415,7 +27626,7 @@ paths: type: integer repositories: type: array - items: *74 + items: *78 repository_selection: type: string example: selected @@ -27538,7 +27749,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *43 + Link: *47 '403': *29 '304': *37 '401': *25 @@ -27622,7 +27833,7 @@ paths: - closed - all default: open - - &363 + - &370 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -27640,8 +27851,8 @@ paths: - updated - comments default: created - - *106 - - *217 + - *110 + - *222 - name: collab in: query required: false @@ -27671,9 +27882,9 @@ paths: application/json: schema: type: array - items: *227 + items: *232 examples: - default: &364 + default: &371 value: - id: 1 node_id: MDU6SXNzdWUx @@ -27917,7 +28128,7 @@ paths: watchers: 1 author_association: COLLABORATOR headers: - Link: *43 + Link: *47 '422': *15 '304': *37 '404': *6 @@ -27956,8 +28167,8 @@ paths: title: License Simple description: License Simple type: object - properties: *228 - required: *229 + properties: *233 + required: *234 examples: default: value: @@ -28242,7 +28453,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &230 + X-CommonMarker-Version: &235 example: 0.17.4 schema: type: string @@ -28297,7 +28508,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *230 + X-CommonMarker-Version: *235 content: text/html: schema: @@ -28326,7 +28537,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &233 + - &238 name: account_id description: account_id parameter in: path @@ -28338,7 +28549,7 @@ paths: description: Response content: application/json: - schema: &232 + schema: &237 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -28368,7 +28579,7 @@ paths: nullable: true id: type: integer - plan: &231 + plan: &236 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -28457,7 +28668,7 @@ paths: nullable: true updated_at: type: string - plan: *231 + plan: *236 required: - url - id @@ -28465,7 +28676,7 @@ paths: - login - marketplace_purchase examples: - default: &234 + default: &239 value: url: https://api.github.com/orgs/github type: Organization @@ -28550,9 +28761,9 @@ paths: application/json: schema: type: array - items: *231 + items: *236 examples: - default: &235 + default: &240 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -28570,7 +28781,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *43 + Link: *47 '404': *6 '401': *25 x-github: @@ -28592,14 +28803,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &236 + - &241 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &237 + - &242 name: sort description: The property to sort the results by. in: query @@ -28629,9 +28840,9 @@ paths: application/json: schema: type: array - items: *232 + items: *237 examples: - default: &238 + default: &243 value: - url: https://api.github.com/orgs/github type: Organization @@ -28682,7 +28893,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *43 + Link: *47 '404': *6 '422': *15 '401': *25 @@ -28705,15 +28916,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *233 + - *238 responses: '200': description: Response content: application/json: - schema: *232 + schema: *237 examples: - default: *234 + default: *239 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -28745,11 +28956,11 @@ paths: application/json: schema: type: array - items: *231 + items: *236 examples: - default: *235 + default: *240 headers: - Link: *43 + Link: *47 '401': *25 x-github: githubCloudOnly: false @@ -28770,8 +28981,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *236 - - *237 + - *241 + - *242 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -28791,11 +29002,11 @@ paths: application/json: schema: type: array - items: *232 + items: *237 examples: - default: *238 + default: *243 headers: - Link: *43 + Link: *47 '401': *25 x-github: githubCloudOnly: false @@ -29057,14 +29268,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &456 + - &462 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &457 + - &463 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -29081,7 +29292,7 @@ paths: application/json: schema: type: array - items: *239 + items: *244 examples: default: value: @@ -29148,7 +29359,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &680 + - &682 name: all description: If `true`, show notifications marked as read. in: query @@ -29156,7 +29367,7 @@ paths: schema: type: boolean default: false - - &681 + - &683 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -29165,8 +29376,8 @@ paths: schema: type: boolean default: false - - *217 - - &682 + - *222 + - &684 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: @@ -29191,18 +29402,18 @@ paths: application/json: schema: type: array - items: &240 + items: &245 title: Thread description: Thread type: object properties: id: type: string - repository: &274 + repository: &281 title: Minimal Repository description: Minimal Repository type: object - properties: &333 + properties: &340 id: type: integer format: int64 @@ -29478,7 +29689,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &408 + security_and_analysis: &415 nullable: true type: object properties: @@ -29560,7 +29771,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &334 + required: &341 - archive_url - assignees_url - blobs_url @@ -29648,7 +29859,7 @@ paths: - url - subscription_url examples: - default: &683 + default: &685 value: - id: '1' repository: @@ -29730,7 +29941,7 @@ paths: url: https://api.github.com/notifications/threads/1 subscription_url: https://api.github.com/notifications/threads/1/subscription headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -29814,7 +30025,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &241 + - &246 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 @@ -29828,7 +30039,7 @@ paths: description: Response content: application/json: - schema: *240 + schema: *245 examples: default: value: @@ -29931,7 +30142,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *241 + - *246 responses: '205': description: Reset Content @@ -29954,7 +30165,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *241 + - *246 responses: '204': description: No content @@ -29977,13 +30188,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *241 + - *246 responses: '200': description: Response content: application/json: - schema: &242 + schema: &247 title: Thread Subscription description: Thread Subscription type: object @@ -30020,7 +30231,7 @@ paths: - url - subscribed examples: - default: &243 + default: &248 value: subscribed: true ignored: false @@ -30051,7 +30262,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *241 + - *246 requestBody: required: false content: @@ -30072,9 +30283,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *247 examples: - default: *243 + default: *248 '304': *37 '403': *29 '401': *25 @@ -30097,7 +30308,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *241 + - *246 responses: '204': description: Response @@ -30192,9 +30403,9 @@ paths: application/json: schema: type: array - items: *69 + items: *73 examples: - default: *244 + default: *249 headers: Link: example: ; rel="next" @@ -30245,7 +30456,7 @@ paths: type: integer custom_roles: type: array - items: &319 + items: &326 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -30293,7 +30504,7 @@ paths: - created_at - updated_at examples: - default: &320 + default: &327 value: id: 8030 name: Security Engineer @@ -30325,6 +30536,152 @@ paths: category: orgs subcategory: custom-roles deprecated: true + "/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/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization + parameters: + - *87 + responses: + '200': + description: Response + content: + application/json: + schema: &250 + 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 + example: 14 + examples: + default: *44 + '403': *29 + '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/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization + parameters: + - *87 + requestBody: + required: true + content: + application/json: + schema: *250 + examples: + selected_actions: *44 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization + parameters: + - *87 + responses: + '200': + description: Response + content: + application/json: + schema: &251 + 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 + example: 10 + examples: + default: *46 + '403': *29 + '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/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization + parameters: + - *87 + requestBody: + required: true + content: + application/json: + schema: *251 + examples: + selected_actions: *46 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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 @@ -30340,7 +30697,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization parameters: - - *83 + - *87 - name: page in: query description: The page number of results to fetch. @@ -30384,8 +30741,8 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: *245 - required: *246 + properties: *252 + required: *253 nullable: true additionalProperties: false examples: @@ -30491,7 +30848,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -30557,7 +30914,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *83 + - *87 requestBody: required: true content: @@ -30609,7 +30966,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -30617,9 +30974,9 @@ paths: application/json: schema: type: array - items: *151 + items: *155 examples: - default: &689 + default: &691 value: - property_name: environment value: production @@ -30653,7 +31010,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -30665,11 +31022,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the organization. - items: *151 + items: *155 required: - properties examples: - default: &690 + default: &692 value: properties: - property_name: environment @@ -30710,13 +31067,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: &247 + schema: &254 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -31049,7 +31406,7 @@ paths: - updated_at - archived_at examples: - default-response: &248 + default-response: &255 value: login: github id: 1 @@ -31151,7 +31508,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - - *83 + - *87 requestBody: required: false content: @@ -31374,18 +31731,18 @@ paths: description: Response content: application/json: - schema: *247 + schema: *254 examples: - default: *248 + default: *255 '422': description: Validation failed content: application/json: schema: oneOf: - - *249 - - *250 - '409': *114 + - *256 + - *257 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31408,7 +31765,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - - *83 + - *87 responses: '202': *39 '404': *6 @@ -31433,17 +31790,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *251 + schema: *258 examples: - default: *252 + default: *259 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31464,7 +31821,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - - *83 + - *87 - *17 - *19 responses: @@ -31482,7 +31839,7 @@ paths: type: integer repository_cache_usages: type: array - items: &473 + items: &475 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -31517,7 +31874,7 @@ paths: active_caches_size_in_bytes: 1022142 active_caches_count: 2 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31537,7 +31894,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *83 + - *87 - *17 - *19 responses: @@ -31555,11 +31912,11 @@ paths: type: integer runners: type: array - items: *44 + items: *48 examples: - default: *253 + default: *260 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31577,7 +31934,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -31654,9 +32011,9 @@ paths: description: Response content: application/json: - schema: *44 + schema: *48 examples: - default: *53 + default: *57 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -31676,7 +32033,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-custom-images-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -31692,9 +32049,9 @@ paths: type: integer images: type: array - items: *45 + items: *49 examples: - default: *47 + default: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31714,16 +32071,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners parameters: - - *83 - - *46 + - *87 + - *50 responses: '200': description: Response content: application/json: - schema: *45 + schema: *49 examples: - default: *254 + default: *261 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31742,8 +32099,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-custom-image-from-the-organization parameters: - - *83 - - *46 + - *87 + - *50 responses: '204': description: Response @@ -31766,8 +32123,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization parameters: - - *46 - - *83 + - *50 + - *87 responses: '200': description: Response @@ -31783,9 +32140,9 @@ paths: type: integer image_versions: type: array - items: *48 + items: *52 examples: - default: *47 + default: *51 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31805,17 +32162,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners parameters: - - *83 - - *46 - - *49 + - *87 + - *50 + - *53 responses: '200': description: Response content: application/json: - schema: *48 + schema: *52 examples: - default: *255 + default: *262 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31834,9 +32191,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization parameters: - - *83 - - *46 - - *49 + - *87 + - *50 + - *53 responses: '204': description: Response @@ -31857,7 +32214,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -31873,9 +32230,9 @@ paths: type: integer images: type: array - items: *50 + items: *54 examples: - default: *51 + default: *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31893,7 +32250,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -31909,9 +32266,9 @@ paths: type: integer images: type: array - items: *50 + items: *54 examples: - default: *51 + default: *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31928,15 +32285,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *256 + schema: *263 examples: - default: *257 + default: *264 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31954,7 +32311,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -31970,9 +32327,9 @@ paths: type: integer machine_specs: type: array - items: *52 + items: *56 examples: - default: *258 + default: *265 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31990,7 +32347,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -32034,18 +32391,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - - *83 - - *54 + - *87 + - *58 responses: '200': description: Response content: application/json: - schema: *44 + schema: *48 examples: - default: *53 + default: *57 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32063,8 +32420,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *83 - - *54 + - *87 + - *58 requestBody: required: true content: @@ -32107,9 +32464,9 @@ paths: description: Response content: application/json: - schema: *44 + schema: *48 examples: - default: *53 + default: *57 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -32125,16 +32482,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *83 - - *54 + - *87 + - *58 responses: '202': description: Response content: application/json: - schema: *44 + schema: *48 examples: - default: *53 + default: *57 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -32154,13 +32511,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *83 + - *87 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &259 + schema: &266 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -32174,7 +32531,7 @@ paths: required: - include_claim_keys examples: - default: &260 + default: &267 value: include_claim_keys: - repo @@ -32196,20 +32553,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: application/json: - schema: *259 + schema: *266 examples: - default: *260 + default: *267 responses: '201': description: Empty response content: application/json: - schema: &285 + schema: &292 title: Empty Object description: An object without any properties. type: object @@ -32239,7 +32596,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -32248,7 +32605,7 @@ paths: schema: type: object properties: - enabled_repositories: &262 + enabled_repositories: &269 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -32261,9 +32618,9 @@ paths: description: The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. - allowed_actions: *56 - selected_actions_url: *261 - sha_pinning_required: *57 + allowed_actions: *60 + selected_actions_url: *268 + sha_pinning_required: *61 required: - enabled_repositories examples: @@ -32293,7 +32650,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *83 + - *87 responses: '204': description: Response @@ -32304,9 +32661,9 @@ paths: schema: type: object properties: - enabled_repositories: *262 - allowed_actions: *56 - sha_pinning_required: *57 + enabled_repositories: *269 + allowed_actions: *60 + sha_pinning_required: *61 required: - enabled_repositories examples: @@ -32334,13 +32691,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *263 + schema: *270 examples: response: summary: Example response @@ -32366,12 +32723,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: application/json: - schema: *264 + schema: *271 examples: application/json: value: @@ -32381,7 +32738,7 @@ paths: description: No content '403': *29 '404': *6 - '409': *114 + '409': *118 '422': *15 x-github: enabledForGitHubApps: true @@ -32401,15 +32758,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *58 + schema: *62 examples: - default: *265 + default: *272 '404': *6 x-github: enabledForGitHubApps: true @@ -32428,7 +32785,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *83 + - *87 responses: '204': description: Response @@ -32438,7 +32795,7 @@ paths: required: true content: application/json: - schema: *58 + schema: *62 examples: default: summary: Set approval policy to first time contributors @@ -32460,15 +32817,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *266 + schema: *273 examples: - default: *59 + default: *63 '403': *29 '404': *6 x-github: @@ -32486,14 +32843,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: application/json: - schema: *267 + schema: *274 examples: - default: *59 + default: *63 responses: '204': description: Empty response for successful settings update @@ -32523,7 +32880,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *83 + - *87 - *17 - *19 responses: @@ -32541,9 +32898,9 @@ paths: type: number repositories: type: array - items: *74 + items: *78 examples: - default: &269 + default: &276 value: total_count: 1 repositories: @@ -32683,7 +33040,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *83 + - *87 responses: '204': description: Response @@ -32727,8 +33084,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *83 - - &268 + - *87 + - &275 name: repository_id description: The unique identifier of the repository. in: path @@ -32756,8 +33113,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *83 - - *268 + - *87 + - *275 responses: '204': description: Response @@ -32780,15 +33137,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *61 + schema: *65 examples: - default: *62 + default: *66 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -32811,7 +33168,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *83 + - *87 responses: '204': description: Response @@ -32819,9 +33176,9 @@ paths: required: false content: application/json: - schema: *61 + schema: *65 examples: - selected_actions: *62 + selected_actions: *66 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -32841,7 +33198,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -32889,7 +33246,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -32916,7 +33273,7 @@ paths: description: No content '403': *29 '404': *6 - '409': *114 + '409': *118 '422': *15 x-github: enabledForGitHubApps: true @@ -32936,7 +33293,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *83 + - *87 - *17 - *19 responses: @@ -32951,9 +33308,9 @@ paths: type: integer repositories: type: array - items: *74 + items: *78 examples: - default: *269 + default: *276 '403': *29 '404': *6 x-github: @@ -32973,7 +33330,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -33021,14 +33378,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *83 - - *268 + - *87 + - *275 responses: '204': description: No content '403': *29 '404': *6 - '409': *114 + '409': *118 '422': *15 x-github: enabledForGitHubApps: true @@ -33048,14 +33405,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - - *83 - - *268 + - *87 + - *275 responses: '204': description: No content '403': *29 '404': *6 - '409': *114 + '409': *118 '422': *15 x-github: enabledForGitHubApps: true @@ -33077,15 +33434,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *270 + schema: *277 examples: - default: *65 + default: *69 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33106,7 +33463,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *83 + - *87 responses: '204': description: Success response @@ -33117,9 +33474,9 @@ paths: required: false content: application/json: - schema: *271 + schema: *278 examples: - default: *65 + default: *69 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33139,7 +33496,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *83 + - *87 - *17 - *19 - name: visible_to_repository @@ -33164,7 +33521,7 @@ paths: type: number runner_groups: type: array - items: &272 + items: &279 type: object properties: id: @@ -33280,7 +33637,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -33352,9 +33709,9 @@ paths: description: Response content: application/json: - schema: *272 + schema: *279 examples: - default: &273 + default: &280 value: id: 2 name: octo-runner-group @@ -33389,14 +33746,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *83 - - *68 + - *87 + - *72 responses: '200': description: Response content: application/json: - schema: *272 + schema: *279 examples: default: value: @@ -33432,8 +33789,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *83 - - *68 + - *87 + - *72 requestBody: required: true content: @@ -33487,9 +33844,9 @@ paths: description: Response content: application/json: - schema: *272 + schema: *279 examples: - default: *273 + default: *280 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -33508,8 +33865,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *83 - - *68 + - *87 + - *72 responses: '204': description: Response @@ -33532,8 +33889,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - - *83 - - *68 + - *87 + - *72 - *17 - *19 responses: @@ -33551,11 +33908,11 @@ paths: type: number runners: type: array - items: *44 + items: *48 examples: - default: *253 + default: *260 headers: - Link: *43 + Link: *47 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -33575,8 +33932,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *83 - - *68 + - *87 + - *72 - *19 - *17 responses: @@ -33594,9 +33951,9 @@ paths: type: number repositories: type: array - items: *274 + items: *281 examples: - default: &805 + default: &804 value: total_count: 1 repositories: @@ -33848,8 +34205,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *83 - - *68 + - *87 + - *72 requestBody: required: true content: @@ -33893,9 +34250,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *83 - - *68 - - *268 + - *87 + - *72 + - *275 responses: '204': description: Response @@ -33917,9 +34274,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *83 - - *68 - - *268 + - *87 + - *72 + - *275 responses: '204': description: Response @@ -33942,8 +34299,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *83 - - *68 + - *87 + - *72 - *17 - *19 responses: @@ -33961,11 +34318,11 @@ paths: type: number runners: type: array - items: *72 + items: *76 examples: - default: *73 + default: *77 headers: - Link: *43 + Link: *47 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -33984,8 +34341,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *83 - - *68 + - *87 + - *72 requestBody: required: true content: @@ -34029,9 +34386,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *83 - - *68 - - *71 + - *87 + - *72 + - *75 responses: '204': description: Response @@ -34053,9 +34410,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *83 - - *68 - - *71 + - *87 + - *72 + - *75 responses: '204': description: Response @@ -34085,7 +34442,7 @@ paths: in: query schema: type: string - - *83 + - *87 - *17 - *19 responses: @@ -34103,11 +34460,11 @@ paths: type: integer runners: type: array - items: *72 + items: *76 examples: - default: *73 + default: *77 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34129,7 +34486,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -34137,9 +34494,9 @@ paths: application/json: schema: type: array - items: *275 + items: *282 examples: - default: *276 + default: *283 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34161,7 +34518,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -34204,10 +34561,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *277 + '201': *284 '404': *6 '422': *7 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34235,15 +34592,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *83 + - *87 responses: '201': description: Response content: application/json: - schema: *75 + schema: *79 examples: - default: *278 + default: *285 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34271,15 +34628,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *83 + - *87 responses: '201': description: Response content: application/json: - schema: *75 + schema: *79 examples: - default: *279 + default: *286 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34301,16 +34658,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *83 - - *71 + - *87 + - *75 responses: '200': description: Response content: application/json: - schema: *72 + schema: *76 examples: - default: *280 + default: *287 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34331,8 +34688,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *83 - - *71 + - *87 + - *75 responses: '204': description: Response @@ -34358,10 +34715,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *83 - - *71 + - *87 + - *75 responses: - '200': *77 + '200': *81 '404': *6 x-github: githubCloudOnly: false @@ -34383,8 +34740,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *83 - - *71 + - *87 + - *75 requestBody: required: true content: @@ -34408,7 +34765,7 @@ paths: - gpu - accelerated responses: - '200': *77 + '200': *81 '404': *6 '422': *7 x-github: @@ -34432,8 +34789,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *83 - - *71 + - *87 + - *75 requestBody: required: true content: @@ -34458,7 +34815,7 @@ paths: - gpu - accelerated responses: - '200': *77 + '200': *81 '404': *6 '422': *7 x-github: @@ -34482,10 +34839,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *83 - - *71 + - *87 + - *75 responses: - '200': *281 + '200': *288 '404': *6 x-github: githubCloudOnly: false @@ -34512,11 +34869,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *83 - - *71 - - *282 + - *87 + - *75 + - *289 responses: - '200': *77 + '200': *81 '404': *6 '422': *7 x-github: @@ -34541,7 +34898,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - - *83 + - *87 - *17 - *19 responses: @@ -34559,7 +34916,7 @@ paths: type: integer secrets: type: array - items: &283 + items: &290 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -34609,7 +34966,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34632,13 +34989,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: &493 + schema: &495 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -34667,7 +35024,7 @@ paths: - key_id - key examples: - default: &494 + default: &496 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -34692,8 +35049,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - - *83 - - &284 + - *87 + - &291 name: secret_name description: The name of the secret. in: path @@ -34705,7 +35062,7 @@ paths: description: Response content: application/json: - schema: *283 + schema: *290 examples: default: value: @@ -34735,8 +35092,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 requestBody: required: true content: @@ -34793,7 +35150,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -34819,8 +35176,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 responses: '204': description: Response @@ -34846,8 +35203,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 - *19 - *17 responses: @@ -34865,9 +35222,9 @@ paths: type: integer repositories: type: array - items: *274 + items: *281 examples: - default: &288 + default: &295 value: total_count: 1 repositories: @@ -34959,8 +35316,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 requestBody: required: true content: @@ -35012,8 +35369,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 - name: repository_id in: path required: true @@ -35046,8 +35403,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 - name: repository_id in: path required: true @@ -35079,8 +35436,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - - *83 - - &478 + - *87 + - &480 name: per_page description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -35104,7 +35461,7 @@ paths: type: integer variables: type: array - items: &286 + items: &293 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -35168,7 +35525,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35189,7 +35546,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - - *83 + - *87 requestBody: required: true content: @@ -35237,7 +35594,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -35262,8 +35619,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - - *83 - - &287 + - *87 + - &294 name: name description: The name of the variable. in: path @@ -35275,7 +35632,7 @@ paths: description: Response content: application/json: - schema: *286 + schema: *293 examples: default: value: @@ -35305,8 +35662,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - - *83 - - *287 + - *87 + - *294 requestBody: required: true content: @@ -35368,8 +35725,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - - *83 - - *287 + - *87 + - *294 responses: '204': description: Response @@ -35395,8 +35752,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *83 - - *287 + - *87 + - *294 - *19 - *17 responses: @@ -35414,9 +35771,9 @@ paths: type: integer repositories: type: array - items: *274 + items: *281 examples: - default: *288 + default: *295 '409': description: Response when the visibility of the variable is not set to `selected` @@ -35442,8 +35799,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *83 - - *287 + - *87 + - *294 requestBody: required: true content: @@ -35492,8 +35849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *83 - - *287 + - *87 + - *294 - name: repository_id in: path required: true @@ -35527,8 +35884,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *83 - - *287 + - *87 + - *294 - name: repository_id in: path required: true @@ -35559,15 +35916,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *81 + default: *85 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -35586,19 +35943,19 @@ paths: required: true content: application/json: - schema: *289 + schema: *296 examples: - default: *81 + default: *85 parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *81 + default: *85 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -35614,7 +35971,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - - *83 + - *87 responses: '204': description: Response @@ -35636,7 +35993,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#create-an-artifact-deployment-record parameters: - - *83 + - *87 requestBody: required: true content: @@ -35743,7 +36100,7 @@ paths: type: integer deployment_records: type: array - items: &290 + items: &297 title: Artifact Deployment Record description: Artifact Metadata Deployment Record type: object @@ -35787,7 +36144,7 @@ paths: with the deployment record. nullable: true examples: - default: &291 + default: &298 value: total_count: 1 deployment_records: @@ -35818,7 +36175,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#set-cluster-deployment-records parameters: - - *83 + - *87 - name: cluster in: path description: The cluster name. @@ -35933,9 +36290,9 @@ paths: type: integer deployment_records: type: array - items: *290 + items: *297 examples: - default: *291 + default: *298 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35955,7 +36312,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - - *83 + - *87 requestBody: required: true content: @@ -36106,7 +36463,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#list-artifact-deployment-records parameters: - - *83 + - *87 - name: subject_digest description: The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. in: path @@ -36131,9 +36488,9 @@ paths: type: integer deployment_records: type: array - items: *290 + items: *297 examples: - default: *291 + default: *298 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36153,7 +36510,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - - *83 + - *87 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -36236,9 +36593,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *104 - - *105 - - *83 + - *108 + - *109 + - *87 requestBody: required: true content: @@ -36262,12 +36619,12 @@ paths: required: - subject_digests examples: - default: &833 + default: &832 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &834 + withPredicateType: &833 value: subject_digests: - sha256:abc123 @@ -36325,7 +36682,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &835 + default: &834 value: attestations_subject_digests: - sha256:abc: @@ -36434,7 +36791,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *83 + - *87 requestBody: required: true content: @@ -36499,7 +36856,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *83 + - *87 - name: subject_digest description: Subject Digest in: path @@ -36532,9 +36889,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestation-repositories parameters: - *17 - - *104 - - *105 - - *83 + - *108 + - *109 + - *87 - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. @@ -36582,7 +36939,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id parameters: - - *83 + - *87 - name: attestation_id description: Attestation ID in: path @@ -36618,9 +36975,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#list-attestations parameters: - *17 - - *104 - - *105 - - *83 + - *108 + - *109 + - *87 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -36674,7 +37031,7 @@ paths: initiator: type: string examples: - default: &507 + default: &509 value: attestations: - bundle: @@ -36792,7 +37149,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization parameters: - - *83 + - *87 - name: phrase description: A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). @@ -36800,10 +37157,10 @@ paths: required: false schema: type: string - - *292 - - *293 - - *294 - - *295 + - *299 + - *300 + - *301 + - *302 - *17 responses: '200': @@ -36812,9 +37169,9 @@ paths: application/json: schema: type: array - items: *296 + items: *303 examples: - default: *297 + default: *304 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -36831,7 +37188,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *83 + - *87 - *17 - *19 responses: @@ -36843,7 +37200,7 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36862,8 +37219,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: If the user is blocked @@ -36888,8 +37245,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response @@ -36909,8 +37266,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response @@ -36936,17 +37293,17 @@ paths: category: orgs subcategory: bypass-requests parameters: - - *83 - - &300 + - *87 + - &307 name: repository_name description: The name of the repository to filter on. in: query schema: type: string - - *99 - - *100 - - *101 - - *102 + - *103 + - *104 + - *105 + - *106 - *17 - *19 responses: @@ -36956,9 +37313,9 @@ paths: application/json: schema: type: array - items: *298 + items: *305 examples: - default: *299 + default: *306 '404': *6 '500': *40 "/orgs/{org}/bypass-requests/secret-scanning": @@ -36981,12 +37338,12 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *83 - - *300 - - *99 - - *100 - - *101 - - *102 + - *87 + - *307 + - *103 + - *104 + - *105 + - *106 - *17 - *19 responses: @@ -36996,9 +37353,9 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *302 + default: *309 '404': *6 '500': *40 "/orgs/{org}/campaigns": @@ -37017,15 +37374,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *83 + - *87 - *19 - *17 - - *106 + - *110 - name: state description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &304 + schema: &311 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -37051,7 +37408,7 @@ paths: application/json: schema: type: array - items: &305 + items: &312 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -37082,7 +37439,7 @@ paths: team_managers: description: The campaign team managers type: array - items: *303 + items: *310 published_at: description: The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. @@ -37100,7 +37457,7 @@ paths: type: string format: date-time nullable: true - state: *304 + state: *311 contact_link: description: The contact link of the campaign. type: string @@ -37195,9 +37552,9 @@ paths: closed_at: state: open headers: - Link: *43 + Link: *47 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37221,7 +37578,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -37320,9 +37677,9 @@ paths: description: Response content: application/json: - schema: *305 + schema: *312 examples: - default: &306 + default: &313 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -37371,7 +37728,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37393,7 +37750,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *83 + - *87 - name: campaign_number description: The campaign number. in: path @@ -37405,16 +37762,16 @@ paths: description: Response content: application/json: - schema: *305 + schema: *312 examples: - default: *306 + default: *313 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37435,7 +37792,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign parameters: - - *83 + - *87 - name: campaign_number description: The campaign number. in: path @@ -37484,7 +37841,7 @@ paths: type: string format: uri nullable: true - state: *304 + state: *311 examples: default: value: @@ -37494,9 +37851,9 @@ paths: description: Response content: application/json: - schema: *305 + schema: *312 examples: - default: *306 + default: *313 '400': description: Bad Request content: @@ -37508,7 +37865,7 @@ paths: content: application/json: schema: *3 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37529,7 +37886,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *83 + - *87 - name: campaign_number description: The campaign number. in: path @@ -37540,7 +37897,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37562,20 +37919,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *83 - - *307 - - *308 - - *104 - - *105 + - *87 + - *314 + - *315 + - *108 + - *109 - *19 - *17 - - *106 + - *110 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: *309 + schema: *316 - name: sort description: The property by which to sort the results. in: query @@ -37591,7 +37948,7 @@ paths: be returned. in: query required: false - schema: &534 + schema: &536 type: string description: Severity of a code scanning alert. enum: @@ -37609,13 +37966,13 @@ paths: application/json: schema: type: array - items: *310 + items: *317 examples: - default: *311 + default: *318 headers: - Link: *43 + Link: *47 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37637,7 +37994,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *83 + - *87 - name: target_type in: query description: The target type of the code security configuration @@ -37656,8 +38013,8 @@ paths: schema: type: integer default: 30 - - *104 - - *105 + - *108 + - *109 responses: '200': description: Response @@ -37665,7 +38022,7 @@ paths: application/json: schema: type: array - items: *110 + items: *114 examples: default: value: @@ -37748,7 +38105,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - - *83 + - *87 requestBody: required: true content: @@ -37826,7 +38183,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *312 + code_scanning_options: *319 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -37835,7 +38192,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: *113 + code_scanning_default_setup_options: *117 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -37967,9 +38324,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *110 + schema: *114 examples: - default: *313 + default: *320 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37991,15 +38348,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '304': *37 '403': *29 '404': *6 @@ -38025,7 +38382,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *83 + - *87 requestBody: required: true content: @@ -38051,11 +38408,11 @@ paths: - 32 - 91 responses: - '204': *150 + '204': *154 '400': *14 '403': *29 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38077,16 +38434,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - - *83 - - *112 + - *87 + - *116 responses: '200': description: Response content: application/json: - schema: *110 + schema: *114 examples: - default: *313 + default: *320 '304': *37 '403': *29 '404': *6 @@ -38110,8 +38467,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - - *83 - - *112 + - *87 + - *116 requestBody: required: true content: @@ -38190,7 +38547,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *113 + code_scanning_default_setup_options: *117 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -38308,7 +38665,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *110 + schema: *114 examples: default: value: @@ -38367,14 +38724,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *83 - - *112 + - *87 + - *116 responses: - '204': *150 + '204': *154 '400': *14 '403': *29 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38398,8 +38755,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *83 - - *112 + - *87 + - *116 requestBody: required: true content: @@ -38462,8 +38819,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *83 - - *112 + - *87 + - *116 requestBody: required: true content: @@ -38503,12 +38860,12 @@ paths: - none - private_and_internal - public - configuration: *110 + configuration: *114 examples: default: value: default_for_new_repos: all - configuration: *313 + configuration: *320 '403': *29 '404': *6 x-github: @@ -38532,8 +38889,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *83 - - *112 + - *87 + - *116 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -38542,8 +38899,8 @@ paths: schema: type: integer default: 30 - - *104 - - *105 + - *108 + - *109 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -38561,13 +38918,13 @@ paths: application/json: schema: type: array - items: *316 + items: *323 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *317 + repository: *324 '403': *29 '404': *6 x-github: @@ -38591,7 +38948,7 @@ paths: parameters: - *17 - *19 - - *83 + - *87 responses: '200': description: Response @@ -38607,7 +38964,7 @@ paths: type: integer codespaces: type: array - items: &365 + items: &372 type: object title: Codespace description: A codespace. @@ -38632,12 +38989,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *274 + repository: *281 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &563 + properties: &565 name: type: string description: The name of the machine. @@ -38679,7 +39036,7 @@ paths: - ready - in_progress nullable: true - required: &564 + required: &566 - name - display_name - operating_system @@ -38884,7 +39241,7 @@ paths: - pulls_url - recent_folders examples: - default: &366 + default: &373 value: total_count: 3 codespaces: @@ -39316,7 +39673,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *83 + - *87 deprecated: true requestBody: required: true @@ -39383,7 +39740,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *83 + - *87 deprecated: true requestBody: required: true @@ -39438,7 +39795,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *83 + - *87 requestBody: required: true content: @@ -39490,7 +39847,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *83 + - *87 - *17 - *19 responses: @@ -39508,7 +39865,7 @@ paths: type: integer secrets: type: array - items: &318 + items: &325 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -39547,7 +39904,7 @@ paths: - updated_at - visibility examples: - default: &565 + default: &567 value: total_count: 2 secrets: @@ -39560,7 +39917,7 @@ paths: updated_at: '2020-01-11T11:59:22Z' visibility: all headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -39579,13 +39936,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: &566 + schema: &568 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -39614,7 +39971,7 @@ paths: - key_id - key examples: - default: &567 + default: &569 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -39637,23 +39994,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 responses: '200': description: Response content: application/json: - schema: *318 + schema: *325 examples: - default: &569 + default: &571 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -39673,8 +40030,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 requestBody: required: true content: @@ -39729,7 +40086,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -39755,8 +40112,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 responses: '204': description: Response @@ -39781,8 +40138,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 - *19 - *17 responses: @@ -39800,9 +40157,9 @@ paths: type: integer repositories: type: array - items: *274 + items: *281 examples: - default: *288 + default: *295 '404': *6 x-github: githubCloudOnly: false @@ -39824,8 +40181,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 requestBody: required: true content: @@ -39875,8 +40232,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 - name: repository_id in: path required: true @@ -39909,8 +40266,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 - name: repository_id in: path required: true @@ -39949,7 +40306,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *83 + - *87 responses: '200': description: OK @@ -40090,7 +40447,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *83 + - *87 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -40113,11 +40470,11 @@ paths: currently being billed. seats: type: array - items: *141 + items: *145 examples: - default: *142 + default: *146 headers: - Link: *43 + Link: *47 '500': *40 '401': *25 '403': *29 @@ -40151,7 +40508,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *83 + - *87 requestBody: content: application/json: @@ -40229,7 +40586,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *83 + - *87 requestBody: content: application/json: @@ -40309,7 +40666,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *83 + - *87 requestBody: content: application/json: @@ -40386,7 +40743,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *83 + - *87 requestBody: content: application/json: @@ -40467,7 +40824,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *83 + - *87 - 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`). @@ -40499,13 +40856,13 @@ paths: application/json: schema: type: array - items: *202 + items: *207 examples: - default: *203 + default: *208 '500': *40 '403': *29 '404': *6 - '422': *204 + '422': *209 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40527,7 +40884,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization parameters: - - *83 + - *87 - *17 - name: page description: Page token @@ -40671,7 +41028,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization parameters: - - *83 + - *87 - name: credential_id in: path required: true @@ -40702,7 +41059,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization parameters: - - *83 + - *87 responses: '200': description: Response - list of custom role names @@ -40717,7 +41074,7 @@ paths: type: integer custom_roles: type: array - items: *319 + items: *326 examples: default: value: @@ -40804,12 +41161,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - - *83 + - *87 requestBody: required: true content: application/json: - schema: &321 + schema: &328 type: object properties: name: @@ -40850,9 +41207,9 @@ paths: description: Response content: application/json: - schema: *319 + schema: *326 examples: - default: *320 + default: *327 '422': *15 '404': *6 x-github: @@ -40876,16 +41233,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - - *83 - - *137 + - *87 + - *141 responses: '200': description: Response content: application/json: - schema: *319 + schema: *326 examples: - default: *320 + default: *327 '404': *6 x-github: githubCloudOnly: true @@ -40907,13 +41264,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - - *83 - - *137 + - *87 + - *141 requestBody: required: true content: application/json: - schema: &322 + schema: &329 type: object properties: name: @@ -40951,9 +41308,9 @@ paths: description: Response content: application/json: - schema: *319 + schema: *326 examples: - default: *320 + default: *327 '422': *15 '404': *6 x-github: @@ -40977,8 +41334,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - - *83 - - *137 + - *87 + - *141 responses: '204': description: Response @@ -41006,12 +41363,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---create-a-custom-role parameters: - - *83 + - *87 requestBody: required: true content: application/json: - schema: *321 + schema: *328 examples: default: value: @@ -41025,9 +41382,9 @@ paths: description: Response content: application/json: - schema: *319 + schema: *326 examples: - default: *320 + default: *327 '422': *15 '404': *6 x-github: @@ -41057,16 +41414,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---get-a-custom-role parameters: - - *83 - - *137 + - *87 + - *141 responses: '200': description: Response content: application/json: - schema: *319 + schema: *326 examples: - default: *320 + default: *327 '404': *6 x-github: githubCloudOnly: true @@ -41094,13 +41451,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---update-a-custom-role parameters: - - *83 - - *137 + - *87 + - *141 requestBody: required: true content: application/json: - schema: *322 + schema: *329 examples: default: value: @@ -41115,9 +41472,9 @@ paths: description: Response content: application/json: - schema: *319 + schema: *326 examples: - default: *320 + default: *327 '422': *15 '404': *6 x-github: @@ -41147,8 +41504,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---delete-a-custom-role parameters: - - *83 - - *137 + - *87 + - *141 responses: '204': description: Response @@ -41176,12 +41533,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *83 - - *323 - - *324 - - *325 - - *326 - - *327 + - *87 + - *330 + - *331 + - *332 + - *333 + - *334 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -41219,11 +41576,11 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *328 - - *329 - - *106 - - *104 - - *105 + - *335 + - *336 + - *110 + - *108 + - *109 - *17 responses: '200': @@ -41232,9 +41589,9 @@ paths: application/json: schema: type: array - items: *330 + items: *337 examples: - default: *331 + default: *338 '304': *37 '400': *14 '403': *29 @@ -41260,7 +41617,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - - *83 + - *87 - *17 - *19 responses: @@ -41278,7 +41635,7 @@ paths: type: integer secrets: type: array - items: &332 + items: &339 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -41328,7 +41685,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41349,13 +41706,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: &595 + schema: &597 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -41372,7 +41729,7 @@ paths: - key_id - key examples: - default: &596 + default: &598 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -41395,14 +41752,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 responses: '200': description: Response content: application/json: - schema: *332 + schema: *339 examples: default: value: @@ -41430,8 +41787,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 requestBody: required: true content: @@ -41490,7 +41847,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -41514,8 +41871,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 responses: '204': description: Response @@ -41539,8 +41896,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 - *19 - *17 responses: @@ -41558,9 +41915,9 @@ paths: type: integer repositories: type: array - items: *274 + items: *281 examples: - default: *288 + default: *295 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41581,8 +41938,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 requestBody: required: true content: @@ -41632,8 +41989,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 - name: repository_id in: path required: true @@ -41664,8 +42021,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *83 - - *284 + - *87 + - *291 - name: repository_id in: path required: true @@ -41701,8 +42058,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *83 - - &604 + - *87 + - &606 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -41710,7 +42067,7 @@ paths: required: false schema: type: string - - &605 + - &607 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -41718,7 +42075,7 @@ paths: required: false schema: type: string - - &606 + - &608 name: time_period description: |- The time period to filter by. @@ -41734,7 +42091,7 @@ paths: - week - month default: month - - &607 + - &609 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -41749,7 +42106,7 @@ paths: - denied - all default: all - - *300 + - *307 - *17 - *19 responses: @@ -41759,7 +42116,7 @@ paths: application/json: schema: type: array - items: &608 + items: &610 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -41915,7 +42272,7 @@ paths: format: uri example: https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &609 + default: &611 value: - id: 21 number: 42 @@ -42001,12 +42358,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *83 - - *300 - - *99 - - *100 - - *101 - - &610 + - *87 + - *307 + - *103 + - *104 + - *105 + - &612 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -42032,7 +42389,7 @@ paths: application/json: schema: type: array - items: &611 + items: &613 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -42142,7 +42499,7 @@ paths: type: array description: The responses to the dismissal request. nullable: true - items: *103 + items: *107 url: type: string format: uri @@ -42153,7 +42510,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &612 + default: &614 value: - id: 21 number: 42 @@ -42233,7 +42590,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -42241,7 +42598,7 @@ paths: application/json: schema: type: array - items: &376 + items: &383 title: Package description: A software package type: object @@ -42291,8 +42648,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *333 - required: *334 + properties: *340 + required: *341 nullable: true created_at: type: string @@ -42311,7 +42668,7 @@ paths: - created_at - updated_at examples: - default: &377 + default: &384 value: - id: 197 name: hello_docker @@ -42389,7 +42746,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - - *83 + - *87 - *17 - *19 responses: @@ -42399,7 +42756,7 @@ paths: application/json: schema: type: array - items: *239 + items: *244 examples: 200-response: value: @@ -42472,7 +42829,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - - *83 + - *87 - name: group_id description: The unique identifier of the group. in: path @@ -42498,7 +42855,7 @@ paths: description: Response content: application/json: - schema: &451 + schema: &459 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -42579,7 +42936,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &452 + default: &460 value: group_id: '123' group_name: Octocat admins @@ -42617,7 +42974,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-external-groups-available-to-an-organization parameters: - - *83 + - *87 - *17 - name: page description: Page token @@ -42634,7 +42991,7 @@ paths: description: Response content: application/json: - schema: &449 + schema: &457 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -42671,7 +43028,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &450 + default: &458 value: groups: - group_id: '123' @@ -42705,7 +43062,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - - *83 + - *87 - *17 - *19 responses: @@ -42715,7 +43072,7 @@ paths: application/json: schema: type: array - items: &357 + items: &364 title: Organization Invitation description: Organization Invitation type: object @@ -42762,7 +43119,7 @@ paths: - invitation_teams_url - node_id examples: - default: &358 + default: &365 value: - id: 1 login: monalisa @@ -42795,7 +43152,7 @@ paths: invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams invitation_source: member headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -42821,7 +43178,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -42829,7 +43186,7 @@ paths: application/json: schema: type: array - items: &409 + items: &416 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -42843,7 +43200,7 @@ paths: - name - description examples: - default: &410 + default: &417 value: - name: add_assignee description: Assign or remove a user @@ -42874,7 +43231,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - - *83 + - *87 - *17 - *19 responses: @@ -42884,7 +43241,7 @@ paths: application/json: schema: type: array - items: &335 + items: &342 title: Org Hook description: Org Hook type: object @@ -42972,7 +43329,7 @@ paths: created_at: '2011-09-06T17:26:27Z' type: Organization headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -42993,7 +43350,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - - *83 + - *87 requestBody: required: true content: @@ -43053,9 +43410,9 @@ paths: description: Response content: application/json: - schema: *335 + schema: *342 examples: - default: &336 + default: &343 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -43099,8 +43456,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - - *83 - - &337 + - *87 + - &344 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. @@ -43113,9 +43470,9 @@ paths: description: Response content: application/json: - schema: *335 + schema: *342 examples: - default: *336 + default: *343 '404': *6 x-github: githubCloudOnly: false @@ -43136,8 +43493,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - - *83 - - *337 + - *87 + - *344 requestBody: required: false content: @@ -43182,7 +43539,7 @@ paths: description: Response content: application/json: - schema: *335 + schema: *342 examples: default: value: @@ -43221,8 +43578,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *83 - - *337 + - *87 + - *344 responses: '204': description: Response @@ -43247,8 +43604,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *83 - - *337 + - *87 + - *344 responses: '200': description: Response @@ -43276,8 +43633,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *83 - - *337 + - *87 + - *344 requestBody: required: false content: @@ -43325,10 +43682,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *83 - - *337 + - *87 + - *344 - *17 - - *338 + - *345 responses: '200': description: Response @@ -43336,9 +43693,9 @@ paths: application/json: schema: type: array - items: *339 + items: *346 examples: - default: *340 + default: *347 '400': *14 '422': *15 x-github: @@ -43361,17 +43718,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *83 - - *337 + - *87 + - *344 - *16 responses: '200': description: Response content: application/json: - schema: *341 + schema: *348 examples: - default: *342 + default: *349 '400': *14 '422': *15 x-github: @@ -43394,8 +43751,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *83 - - *337 + - *87 + - *344 - *16 responses: '202': *39 @@ -43421,8 +43778,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *83 - - *337 + - *87 + - *344 responses: '204': description: Response @@ -43444,8 +43801,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *83 - - &347 + - *87 + - &354 name: actor_type in: path description: The type of the actor @@ -43458,14 +43815,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &348 + - &355 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &343 + - &350 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`.' @@ -43473,7 +43830,7 @@ paths: required: true schema: type: string - - &344 + - &351 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) @@ -43484,7 +43841,7 @@ paths: type: string - *19 - *17 - - *106 + - *110 - name: sort description: The property to sort the results by. in: query @@ -43566,13 +43923,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - - *83 - - *343 - - *344 + - *87 + - *350 + - *351 - *19 - *17 - - *106 - - &353 + - *110 + - &360 name: sort description: The property to sort the results by. in: query @@ -43650,15 +44007,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - - *83 - - *343 - - *344 + - *87 + - *350 + - *351 responses: '200': description: Response content: application/json: - schema: &345 + schema: &352 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -43674,7 +44031,7 @@ paths: type: integer format: int64 examples: - default: &346 + default: &353 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -43694,24 +44051,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *83 - - &349 + - *87 + - &356 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *343 - - *344 + - *350 + - *351 responses: '200': description: Response content: application/json: - schema: *345 + schema: *352 examples: - default: *346 + default: *353 x-github: enabledForGitHubApps: true category: orgs @@ -43729,19 +44086,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *83 - - *343 - - *344 - - *347 - - *348 + - *87 + - *350 + - *351 + - *354 + - *355 responses: '200': description: Response content: application/json: - schema: *345 + schema: *352 examples: - default: *346 + default: *353 x-github: enabledForGitHubApps: true category: orgs @@ -43758,10 +44115,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - - *83 - - *343 - - *344 - - &350 + - *87 + - *350 + - *351 + - &357 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -43774,7 +44131,7 @@ paths: description: Response content: application/json: - schema: &351 + schema: &358 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -43790,7 +44147,7 @@ paths: type: integer format: int64 examples: - default: &352 + default: &359 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -43826,19 +44183,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - - *83 - - *349 - - *343 - - *344 + - *87 + - *356 - *350 + - *351 + - *357 responses: '200': description: Response content: application/json: - schema: *351 + schema: *358 examples: - default: *352 + default: *359 x-github: enabledForGitHubApps: true category: orgs @@ -43855,20 +44212,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *83 - - *347 - - *348 - - *343 - - *344 + - *87 + - *354 + - *355 - *350 + - *351 + - *357 responses: '200': description: Response content: application/json: - schema: *351 + schema: *358 examples: - default: *352 + default: *359 x-github: enabledForGitHubApps: true category: orgs @@ -43885,14 +44242,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - - *83 - - *349 - - *343 - - *344 + - *87 + - *356 + - *350 + - *351 - *19 - *17 - - *106 - - *353 + - *110 + - *360 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -43965,7 +44322,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *83 + - *87 responses: '200': description: Response @@ -43973,7 +44330,7 @@ paths: application/json: schema: *22 examples: - default: &643 + default: &645 value: id: 1 account: @@ -44042,7 +44399,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *83 + - *87 - *17 - *19 responses: @@ -44112,7 +44469,7 @@ paths: suspended_at: suspended_by: headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44131,7 +44488,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -44139,12 +44496,12 @@ paths: application/json: schema: anyOf: - - &355 + - &362 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &354 + limit: &361 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -44169,7 +44526,7 @@ paths: properties: {} additionalProperties: false examples: - default: &356 + default: &363 value: limit: collaborators_only origin: organization @@ -44193,18 +44550,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: application/json: - schema: &644 + schema: &646 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *354 + limit: *361 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -44228,9 +44585,9 @@ paths: description: Response content: application/json: - schema: *355 + schema: *362 examples: - default: *356 + default: *363 '422': *15 x-github: githubCloudOnly: false @@ -44248,7 +44605,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *83 + - *87 responses: '204': description: Response @@ -44274,7 +44631,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - - *83 + - *87 - *17 - *19 - name: role @@ -44308,11 +44665,11 @@ paths: application/json: schema: type: array - items: *357 + items: *364 examples: - default: *358 + default: *365 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -44334,7 +44691,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - - *83 + - *87 requestBody: required: false content: @@ -44388,7 +44745,7 @@ paths: description: Response content: application/json: - schema: *357 + schema: *364 examples: default: value: @@ -44444,8 +44801,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - - *83 - - &359 + - *87 + - &366 name: invitation_id description: The unique identifier of the invitation. in: path @@ -44478,8 +44835,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - - *83 - - *359 + - *87 + - *366 - *17 - *19 responses: @@ -44489,9 +44846,9 @@ paths: application/json: schema: type: array - items: *303 + items: *310 examples: - default: &375 + default: &382 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -44507,7 +44864,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -44526,7 +44883,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -44534,7 +44891,7 @@ paths: application/json: schema: type: array - items: *360 + items: *367 examples: default: value: @@ -44572,7 +44929,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -44619,9 +44976,9 @@ paths: description: Response content: application/json: - schema: *360 + schema: *367 examples: - default: &361 + default: &368 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -44653,8 +45010,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *83 - - &362 + - *87 + - &369 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -44707,9 +45064,9 @@ paths: description: Response content: application/json: - schema: *360 + schema: *367 examples: - default: *361 + default: *368 '404': *6 '422': *7 x-github: @@ -44733,8 +45090,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *83 - - *362 + - *87 + - *369 responses: '204': description: Response @@ -44767,7 +45124,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *83 + - *87 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -44797,7 +45154,7 @@ paths: - closed - all default: open - - *363 + - *370 - name: type description: Can be the name of an issue type. in: query @@ -44815,8 +45172,8 @@ paths: - updated - comments default: created - - *106 - - *217 + - *110 + - *222 - *17 - *19 responses: @@ -44826,11 +45183,11 @@ paths: application/json: schema: type: array - items: *227 + items: *232 examples: - default: *364 + default: *371 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -44850,7 +45207,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - - *83 + - *87 - 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) @@ -44888,9 +45245,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 '422': *15 x-github: githubCloudOnly: false @@ -44908,8 +45265,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response if requester is an organization member and user is @@ -44943,8 +45300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response @@ -44970,8 +45327,8 @@ paths: parameters: - *17 - *19 - - *83 - - *138 + - *87 + - *142 responses: '200': description: Response @@ -44987,9 +45344,9 @@ paths: type: integer codespaces: type: array - items: *365 + items: *372 examples: - default: *366 + default: *373 '304': *37 '500': *40 '401': *25 @@ -45014,9 +45371,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *83 - - *138 - - &367 + - *87 + - *142 + - &374 name: codespace_name in: path required: true @@ -45049,17 +45406,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *83 - - *138 - - *367 + - *87 + - *142 + - *374 responses: '200': description: Response content: application/json: - schema: *365 + schema: *372 examples: - default: &562 + default: &564 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -45232,14 +45589,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *83 - - *138 + - *87 + - *142 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *141 + schema: *145 examples: default: value: @@ -45308,14 +45665,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - - *83 - - *138 + - *87 + - *142 responses: '200': description: Response content: application/json: - schema: &368 + schema: &375 title: Org Membership description: Org Membership type: object @@ -45359,7 +45716,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *69 + organization: *73 user: title: Simple User description: A GitHub user. @@ -45382,7 +45739,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &369 + response-if-user-has-an-active-admin-membership-with-organization: &376 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -45450,8 +45807,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - - *83 - - *138 + - *87 + - *142 requestBody: required: false content: @@ -45479,9 +45836,9 @@ paths: description: Response content: application/json: - schema: *368 + schema: *375 examples: - response-if-user-already-had-membership-with-organization: *369 + response-if-user-already-had-membership-with-organization: *376 '422': *15 '403': *29 x-github: @@ -45505,8 +45862,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response @@ -45531,7 +45888,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - - *83 + - *87 - *17 - *19 - name: exclude @@ -45552,7 +45909,7 @@ paths: application/json: schema: type: array - items: &370 + items: &377 title: Migration description: A migration. type: object @@ -45593,7 +45950,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *74 + items: *78 url: type: string format: uri @@ -45789,7 +46146,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -45805,7 +46162,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - - *83 + - *87 requestBody: required: true content: @@ -45881,7 +46238,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *377 examples: default: value: @@ -46059,8 +46416,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - - *83 - - &371 + - *87 + - &378 name: migration_id description: The unique identifier of the migration. in: path @@ -46087,7 +46444,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *370 + schema: *377 examples: default: value: @@ -46256,8 +46613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *83 - - *371 + - *87 + - *378 responses: '302': description: Response @@ -46278,8 +46635,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *83 - - *371 + - *87 + - *378 responses: '204': description: Response @@ -46302,9 +46659,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - - *83 - - *371 - - &818 + - *87 + - *378 + - &817 name: repo_name description: repo_name parameter in: path @@ -46331,8 +46688,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *83 - - *371 + - *87 + - *378 - *17 - *19 responses: @@ -46342,9 +46699,9 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: &382 + default: &389 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -46455,7 +46812,7 @@ paths: secret_scanning_validity_checks: status: disabled headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -46483,7 +46840,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -46537,7 +46894,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response - list of organization roles @@ -46553,7 +46910,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &372 + items: &379 title: Organization Role description: Organization roles type: object @@ -46713,7 +47070,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - - *83 + - *87 requestBody: required: true content: @@ -46760,7 +47117,7 @@ paths: description: Response content: application/json: - schema: *372 + schema: *379 examples: default: value: @@ -46789,7 +47146,7 @@ paths: updated_at: '2022-07-04T22:19:11Z' '422': *15 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -46811,8 +47168,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *83 - - *210 + - *87 + - *215 responses: '204': description: Response @@ -46837,9 +47194,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *83 - - *210 - - *137 + - *87 + - *215 + - *141 responses: '204': description: Response @@ -46868,9 +47225,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *83 - - *210 - - *137 + - *87 + - *215 + - *141 responses: '204': description: Response @@ -46895,8 +47252,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response @@ -46921,9 +47278,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *83 - - *138 - - *137 + - *87 + - *142 + - *141 responses: '204': description: Response @@ -46953,9 +47310,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *83 - - *138 - - *137 + - *87 + - *142 + - *141 responses: '204': description: Response @@ -46983,14 +47340,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - - *83 - - *137 + - *87 + - *141 responses: '200': description: Response content: application/json: - schema: *372 + schema: *379 examples: default: value: @@ -47047,8 +47404,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - - *83 - - *137 + - *87 + - *141 requestBody: required: true content: @@ -47087,7 +47444,7 @@ paths: description: Response content: application/json: - schema: *372 + schema: *379 examples: default: value: @@ -47115,7 +47472,7 @@ paths: created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': *15 - '409': *114 + '409': *118 '404': *6 x-github: githubCloudOnly: true @@ -47140,8 +47497,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - - *83 - - *137 + - *87 + - *141 responses: '204': description: Response @@ -47166,8 +47523,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *83 - - *137 + - *87 + - *141 - *17 - *19 responses: @@ -47245,8 +47602,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *373 - required: *374 + properties: *380 + required: *381 nullable: true type: description: The ownership type of the team @@ -47278,9 +47635,9 @@ paths: - type - parent examples: - default: *375 + default: *382 headers: - Link: *43 + Link: *47 '404': description: Response if the organization or role does not exist. '422': @@ -47307,8 +47664,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *83 - - *137 + - *87 + - *141 - *17 - *19 responses: @@ -47336,13 +47693,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &429 + items: &437 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *373 - required: *374 + properties: *380 + required: *381 name: nullable: true type: string @@ -47437,9 +47794,9 @@ paths: - type - url examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 '404': description: Response if the organization or role does not exist. '422': @@ -47461,7 +47818,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *83 + - *87 - 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) @@ -47488,9 +47845,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47513,8 +47870,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *83 - - *138 + - *87 + - *142 requestBody: required: false content: @@ -47571,8 +47928,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response @@ -47629,8 +47986,8 @@ paths: - docker - nuget - container - - *83 - - &819 + - *87 + - &818 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -47666,12 +48023,12 @@ paths: application/json: schema: type: array - items: *376 + items: *383 examples: - default: *377 + default: *384 '403': *29 '401': *25 - '400': &821 + '400': &820 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -47693,7 +48050,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &378 + - &385 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 @@ -47711,20 +48068,20 @@ paths: - docker - nuget - container - - &379 + - &386 name: package_name description: The name of the package. in: path required: true schema: type: string - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *376 + schema: *383 examples: default: value: @@ -47776,9 +48133,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *378 - - *379 - - *83 + - *385 + - *386 + - *87 responses: '204': description: Response @@ -47810,9 +48167,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *378 - - *379 - - *83 + - *385 + - *386 + - *87 - name: token description: package token schema: @@ -47844,9 +48201,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *378 - - *379 - - *83 + - *385 + - *386 + - *87 - *19 - *17 - name: state @@ -47866,7 +48223,7 @@ paths: application/json: schema: type: array - items: &380 + items: &387 title: Package Version description: A version of a software package type: object @@ -47991,10 +48348,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *378 - - *379 - - *83 - - &381 + - *385 + - *386 + - *87 + - &388 name: package_version_id description: Unique identifier of the package version. in: path @@ -48006,7 +48363,7 @@ paths: description: Response content: application/json: - schema: *380 + schema: *387 examples: default: value: @@ -48042,10 +48399,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *378 - - *379 - - *83 - - *381 + - *385 + - *386 + - *87 + - *388 responses: '204': description: Response @@ -48077,10 +48434,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *378 - - *379 - - *83 - - *381 + - *385 + - *386 + - *87 + - *388 responses: '204': description: Response @@ -48107,10 +48464,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *83 + - *87 - *17 - *19 - - &383 + - &390 name: sort description: The property by which to sort the results. in: query @@ -48120,8 +48477,8 @@ paths: enum: - created_at default: created_at - - *106 - - &384 + - *110 + - &391 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -48132,7 +48489,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &385 + - &392 name: repository description: The name of the repository to use to filter the results. in: query @@ -48140,7 +48497,7 @@ paths: schema: type: string example: Hello-World - - &386 + - &393 name: permission description: The permission to use to filter the results. in: query @@ -48148,7 +48505,7 @@ paths: schema: type: string example: issues_read - - &387 + - &394 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) @@ -48158,7 +48515,7 @@ paths: schema: type: string format: date-time - - &388 + - &395 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) @@ -48168,7 +48525,7 @@ paths: schema: type: string format: date-time - - &389 + - &396 name: token_id description: The ID of the token in: query @@ -48312,7 +48669,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48332,7 +48689,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *83 + - *87 requestBody: required: true content: @@ -48398,7 +48755,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *83 + - *87 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -48438,7 +48795,7 @@ paths: '422': *15 '404': *6 '403': *29 - '204': *150 + '204': *154 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48459,7 +48816,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *83 + - *87 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -48479,11 +48836,11 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: *382 + default: *389 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48504,17 +48861,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *83 + - *87 - *17 - *19 - - *383 - - *106 - - *384 - - *385 - - *386 - - *387 - - *388 - - *389 + - *390 + - *110 + - *391 + - *392 + - *393 + - *394 + - *395 + - *396 responses: '500': *40 '422': *15 @@ -48643,7 +49000,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48663,7 +49020,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *83 + - *87 requestBody: required: true content: @@ -48723,7 +49080,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *83 + - *87 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -48753,7 +49110,7 @@ paths: responses: '500': *40 '404': *6 - '204': *150 + '204': *154 '403': *29 '422': *15 x-github: @@ -48775,7 +49132,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *83 + - *87 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -48794,11 +49151,11 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: *382 + default: *389 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48820,7 +49177,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *83 + - *87 - *17 - *19 responses: @@ -48838,7 +49195,7 @@ paths: type: integer configurations: type: array - items: &390 + items: &397 title: Organization private registry description: Private registry configuration for an organization type: object @@ -48918,7 +49275,7 @@ paths: updated_at: '2020-01-10T14:59:22Z' visibility: selected headers: - Link: *43 + Link: *47 '400': *14 '404': *6 x-github: @@ -48940,7 +49297,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -49128,7 +49485,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &391 + org-private-registry-with-selected-visibility: &398 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -49169,7 +49526,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -49195,7 +49552,7 @@ paths: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -49217,16 +49574,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *83 - - *284 + - *87 + - *291 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *390 + schema: *397 examples: - default: *391 + default: *398 '404': *6 x-github: githubCloudOnly: false @@ -49247,8 +49604,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *83 - - *284 + - *87 + - *291 requestBody: required: true content: @@ -49352,8 +49709,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *83 - - *284 + - *87 + - *291 responses: '204': description: Response @@ -49376,15 +49733,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-organization parameters: - - *83 + - *87 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *104 - - *105 + - *108 + - *109 - *17 responses: '200': @@ -49393,7 +49750,7 @@ paths: application/json: schema: type: array - items: &392 + items: &399 title: Projects v2 Project description: A projects v2 project type: object @@ -49463,7 +49820,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &898 + properties: &906 id: type: number description: The unique identifier of the status update. @@ -49511,7 +49868,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &899 + required: &907 - id - node_id - created_at @@ -49536,7 +49893,7 @@ paths: - deleted_at - deleted_by examples: - default: &393 + default: &400 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -49619,7 +49976,7 @@ paths: updated_at: '2025-07-11T16:19:28Z' is_template: true headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -49639,24 +49996,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-organization parameters: - - &394 + - &401 name: project_number description: The project's number. in: path required: true schema: type: integer - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *392 + schema: *399 examples: - default: *393 + default: *400 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -49676,8 +50033,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - - *83 - - *394 + - *87 + - *401 requestBody: required: true description: Details of the draft item to create in the project. @@ -49711,7 +50068,7 @@ paths: description: Response content: application/json: - schema: &400 + schema: &407 title: Projects v2 Item description: An item belonging to a project type: object @@ -49724,8 +50081,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *227 - - &577 + - *232 + - &579 title: Pull Request Simple description: Pull Request Simple type: object @@ -49831,8 +50188,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *395 - required: *396 + properties: *402 + required: *403 nullable: true active_lock_reason: type: string @@ -49877,7 +50234,7 @@ paths: nullable: true requested_teams: type: array - items: *303 + items: *310 nullable: true head: type: object @@ -49886,7 +50243,7 @@ paths: type: string ref: type: string - repo: *74 + repo: *78 sha: type: string user: @@ -49909,7 +50266,7 @@ paths: type: string ref: type: string - repo: *74 + repo: *78 sha: type: string user: @@ -49928,7 +50285,7 @@ paths: _links: type: object properties: - comments: &397 + comments: &404 title: Link description: Hypermedia Link type: object @@ -49937,13 +50294,13 @@ paths: type: string required: - href - commits: *397 - statuses: *397 - html: *397 - issue: *397 - review_comments: *397 - review_comment: *397 - self: *397 + commits: *404 + statuses: *404 + html: *404 + issue: *404 + review_comments: *404 + review_comment: *404 + self: *404 required: - comments - commits @@ -49953,8 +50310,8 @@ paths: - review_comments - review_comment - self - author_association: *214 - auto_merge: &692 + author_association: *219 + auto_merge: &694 title: Auto merge description: The status of auto merging a pull request. type: object @@ -50056,7 +50413,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &399 + content_type: &406 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -50096,7 +50453,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &401 + draft_issue: &408 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -50170,11 +50527,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-organization parameters: - - *394 - - *83 + - *401 + - *87 - *17 - - *104 - - *105 + - *108 + - *109 responses: '200': description: Response @@ -50182,7 +50539,7 @@ paths: application/json: schema: type: array - items: &398 + items: &405 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -50329,7 +50686,7 @@ paths: - updated_at - project_url examples: - default: &838 + default: &837 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -50440,10 +50797,300 @@ paths: created_at: '2022-06-20T16:45:00Z' updated_at: '2022-06-20T16:45:00Z' headers: - Link: *43 + Link: *47 + '304': *37 + '403': *29 + '401': *25 + 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/enterprise-cloud@latest//rest/projects/fields#add-a-field-to-an-organization-owned-project + parameters: + - *401 + - *87 + 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: &838 + 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: &839 + 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: &840 + 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: &841 + 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: *405 + examples: + text_field: &842 + 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: &843 + 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: &844 + 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: &845 + 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: &846 + 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': *37 '403': *29 '401': *25 + '422': *15 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50460,23 +51107,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - - *394 - - &839 + - *401 + - &847 name: field_id description: The unique identifier of the field. in: path required: true schema: type: integer - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *398 + schema: *405 examples: - default: &840 + default: &848 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -50485,21 +51132,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: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -50520,8 +51179,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *394 - - *83 + - *401 + - *87 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. @@ -50543,8 +51202,8 @@ paths: maxItems: 50 items: type: string - - *104 - - *105 + - *108 + - *109 - *17 responses: '200': @@ -50553,7 +51212,7 @@ paths: application/json: schema: type: array - items: &402 + items: &409 title: Projects v2 Item description: An item belonging to a project type: object @@ -50569,7 +51228,7 @@ paths: format: uri example: https://api.github.com/users/monalisa/2/projectsV2/3 description: The API URL of the project that contains this item. - content_type: *399 + content_type: *406 content: type: object additionalProperties: true @@ -50612,7 +51271,7 @@ paths: - updated_at - archived_at examples: - default: &403 + default: &410 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -51288,7 +51947,7 @@ paths: type: sub_issues_progress value: headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -51308,8 +51967,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-organization-owned-project parameters: - - *83 - - *394 + - *87 + - *401 requestBody: required: true description: Details of the item to add to the project. @@ -51346,10 +52005,10 @@ paths: description: Response content: application/json: - schema: *400 + schema: *407 examples: - issue: *401 - pull_request: *401 + issue: *408 + pull_request: *408 '304': *37 '403': *29 '401': *25 @@ -51369,9 +52028,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *394 - - *83 - - &404 + - *401 + - *87 + - &411 name: item_id description: The unique identifier of the project item. in: path @@ -51397,11 +52056,11 @@ paths: description: Response content: application/json: - schema: *402 + schema: *409 examples: - default: *403 + default: *410 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -51420,9 +52079,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-organization parameters: - - *394 - - *83 - - *404 + - *401 + - *87 + - *411 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -51492,13 +52151,13 @@ paths: description: Response content: application/json: - schema: *402 + schema: *409 examples: - text_field: *403 - number_field: *403 - date_field: *403 - single_select_field: *403 - iteration_field: *403 + text_field: *410 + number_field: *410 + date_field: *410 + single_select_field: *410 + iteration_field: *410 '401': *25 '403': *29 '404': *6 @@ -51518,9 +52177,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-organization parameters: - - *394 - - *83 - - *404 + - *401 + - *87 + - *411 responses: '204': description: Response @@ -51544,7 +52203,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -51552,9 +52211,9 @@ paths: application/json: schema: type: array - items: *152 + items: *156 examples: - default: *153 + default: *157 '403': *29 '404': *6 x-github: @@ -51581,7 +52240,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -51592,7 +52251,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *152 + items: *156 minItems: 1 maxItems: 100 required: @@ -51622,9 +52281,9 @@ paths: application/json: schema: type: array - items: *152 + items: *156 examples: - default: *153 + default: *157 '403': *29 '404': *6 x-github: @@ -51645,16 +52304,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *83 - - *148 + - *87 + - *152 responses: '200': description: Response content: application/json: - schema: *152 + schema: *156 examples: - default: *154 + default: *158 '403': *29 '404': *6 x-github: @@ -51677,13 +52336,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *83 - - *148 + - *87 + - *152 requestBody: required: true content: application/json: - schema: *405 + schema: *412 examples: default: value: @@ -51699,9 +52358,9 @@ paths: description: Response content: application/json: - schema: *152 + schema: *156 examples: - default: *154 + default: *158 '403': *29 '404': *6 x-github: @@ -51724,10 +52383,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *83 - - *148 + - *87 + - *152 responses: - '204': *150 + '204': *154 '403': *29 '404': *6 x-github: @@ -51748,7 +52407,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *83 + - *87 - *17 - *19 - name: repository_query @@ -51786,7 +52445,7 @@ paths: example: octocat/Hello-World properties: type: array - items: *151 + items: *155 description: List of custom property names and associated values required: - repository_id @@ -51807,7 +52466,7 @@ paths: - property_name: team value: octocat headers: - Link: *43 + Link: *47 '403': *29 '404': *6 x-github: @@ -51835,7 +52494,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *83 + - *87 requestBody: required: true content: @@ -51855,7 +52514,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *151 + items: *155 required: - repository_names - properties @@ -51896,7 +52555,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - - *83 + - *87 - *17 - *19 responses: @@ -51908,9 +52567,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51927,8 +52586,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response if user is a public member @@ -51952,8 +52611,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response @@ -51974,8 +52633,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *83 - - *138 + - *87 + - *142 responses: '204': description: Response @@ -51999,7 +52658,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - - *83 + - *87 - name: type description: Specifies the types of repositories you want returned. `internal` is not yet supported when a GitHub App calls this endpoint with an installation @@ -52046,11 +52705,11 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: *382 + default: *389 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52069,7 +52728,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - - *83 + - *87 requestBody: required: true content: @@ -52528,8 +53187,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *406 - required: *407 + properties: *413 + required: *414 nullable: true temp_clone_token: type: string @@ -52616,8 +53275,8 @@ paths: title: License Simple description: License Simple type: object - properties: *228 - required: *229 + properties: *233 + required: *234 nullable: true organization: title: Simple User @@ -52626,8 +53285,8 @@ paths: properties: *20 required: *21 nullable: true - parent: *74 - source: *74 + parent: *78 + source: *78 forks: type: integer master_branch: @@ -52644,7 +53303,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &582 + properties: &584 url: type: string format: uri @@ -52660,12 +53319,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &583 + required: &585 - url - key - name - html_url - security_and_analysis: *408 + security_and_analysis: *415 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -53267,7 +53926,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Response @@ -53275,9 +53934,9 @@ paths: application/json: schema: type: array - items: *409 + items: *416 examples: - default: *410 + default: *417 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -53299,10 +53958,10 @@ paths: category: orgs subcategory: rules parameters: - - *83 + - *87 - *17 - *19 - - &715 + - &716 name: targets description: | A comma-separated list of rule targets to filter by. @@ -53320,7 +53979,7 @@ paths: application/json: schema: type: array - items: *185 + items: *190 examples: default: value: @@ -53367,7 +54026,7 @@ paths: category: orgs subcategory: rules parameters: - - *83 + - *87 requestBody: description: Request body required: true @@ -53388,24 +54047,20 @@ paths: - push - repository default: branch - enforcement: *163 + enforcement: *167 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *164 - conditions: *411 + items: *168 + conditions: *418 rules: type: array description: An array of rules within the ruleset. - items: &413 + items: &420 title: Repository Rule type: object description: A repository rule. oneOf: - - *165 - - *166 - - *167 - - *168 - *169 - *170 - *171 @@ -53422,6 +54077,11 @@ paths: - *182 - *183 - *184 + - *185 + - *186 + - *187 + - *188 + - *189 required: - name - enforcement @@ -53459,9 +54119,9 @@ paths: description: Response content: application/json: - schema: *185 + schema: *190 examples: - default: &412 + default: &419 value: id: 21 name: super cool ruleset @@ -53515,8 +54175,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *83 - - &717 + - *87 + - &718 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 @@ -53526,16 +54186,16 @@ paths: schema: type: string x-multi-segment: true - - *300 - - *101 - - &718 + - *307 + - *105 + - &719 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 - - &719 + - &720 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -53555,7 +54215,7 @@ paths: description: Response content: application/json: - schema: &720 + schema: &721 title: Rule Suites description: Response type: array @@ -53610,7 +54270,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &721 + default: &722 value: - id: 21 actor_id: 12 @@ -53653,8 +54313,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *83 - - &722 + - *87 + - &723 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -53670,7 +54330,7 @@ paths: description: Response content: application/json: - schema: &723 + schema: &724 title: Rule Suite description: Response type: object @@ -53769,7 +54429,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &724 + default: &725 value: id: 21 actor_id: 12 @@ -53830,7 +54490,7 @@ paths: category: orgs subcategory: rules parameters: - - *83 + - *87 - name: ruleset_id description: The ID of the ruleset. in: path @@ -53842,9 +54502,9 @@ paths: description: Response content: application/json: - schema: *185 + schema: *190 examples: - default: *412 + default: *419 '404': *6 '500': *40 put: @@ -53862,7 +54522,7 @@ paths: category: orgs subcategory: rules parameters: - - *83 + - *87 - name: ruleset_id description: The ID of the ruleset. in: path @@ -53888,16 +54548,16 @@ paths: - tag - push - repository - enforcement: *163 + enforcement: *167 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *164 - conditions: *411 + items: *168 + conditions: *418 rules: description: An array of rules within the ruleset. type: array - items: *413 + items: *420 examples: default: value: @@ -53932,9 +54592,9 @@ paths: description: Response content: application/json: - schema: *185 + schema: *190 examples: - default: *412 + default: *419 '404': *6 '500': *40 delete: @@ -53952,7 +54612,7 @@ paths: category: orgs subcategory: rules parameters: - - *83 + - *87 - name: ruleset_id description: The ID of the ruleset. in: path @@ -53975,7 +54635,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-history parameters: - - *83 + - *87 - *17 - *19 - name: ruleset_id @@ -53991,9 +54651,9 @@ paths: application/json: schema: type: array - items: *189 + items: *194 examples: - default: *414 + default: *421 '404': *6 '500': *40 x-github: @@ -54012,7 +54672,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-version parameters: - - *83 + - *87 - name: ruleset_id description: The ID of the ruleset. in: path @@ -54030,7 +54690,7 @@ paths: description: Response content: application/json: - schema: *415 + schema: *422 examples: default: value: @@ -54092,15 +54752,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *83 - - *416 - - *417 - - *418 - - *419 - - *106 + - *87 + - *423 + - *424 + - *425 + - *426 + - *427 + - *110 - *19 - *17 - - &726 + - &727 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -54110,7 +54771,7 @@ paths: required: false schema: type: string - - &727 + - &728 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -54120,10 +54781,10 @@ paths: required: false schema: type: string - - *420 - - *421 - - *422 - - *423 + - *428 + - *429 + - *430 + - *431 responses: '200': description: Response @@ -54131,13 +54792,13 @@ paths: application/json: schema: type: array - items: *424 + items: *432 examples: - default: *425 + default: *433 headers: - Link: *43 + Link: *47 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54162,15 +54823,15 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *426 + schema: *434 examples: - default: *427 + default: *435 '403': *29 '404': *6 patch: @@ -54191,7 +54852,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *83 + - *87 requestBody: required: true content: @@ -54199,7 +54860,7 @@ paths: schema: type: object properties: - pattern_config_version: *192 + pattern_config_version: *197 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -54225,7 +54886,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *192 + custom_pattern_version: *197 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -54261,7 +54922,7 @@ paths: '400': *14 '403': *29 '404': *6 - '409': *114 + '409': *118 '422': *15 "/orgs/{org}/security-advisories": get: @@ -54279,8 +54940,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *83 - - *106 + - *87 + - *110 - name: sort description: The property to sort the results by. in: query @@ -54292,8 +54953,8 @@ paths: - updated - published default: created - - *104 - - *105 + - *108 + - *109 - name: per_page description: The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -54323,7 +54984,7 @@ paths: application/json: schema: type: array - items: &748 + items: &749 description: A repository security advisory. type: object properties: @@ -54510,7 +55171,7 @@ paths: required: - vector_string - score - cvss_severities: *125 + cvss_severities: *129 cwes: type: array nullable: true @@ -54543,7 +55204,7 @@ paths: login: type: string description: The username of the user credited. - type: *428 + type: *436 credits_detailed: type: array nullable: true @@ -54553,7 +55214,7 @@ paths: type: object properties: user: *4 - type: *428 + type: *436 state: type: string description: The state of the user's acceptance of the @@ -54577,14 +55238,14 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *303 + items: *310 private_fork: readOnly: true nullable: true description: A temporary private fork of the advisory's repository for collaborating on a fix. allOf: - - *115 + - *119 required: - ghsa_id - cve_id @@ -54614,7 +55275,7 @@ paths: - private_fork additionalProperties: false examples: - default: &749 + default: &750 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -54993,7 +55654,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - - *83 + - *87 responses: '200': description: Response @@ -55001,9 +55662,9 @@ paths: application/json: schema: type: array - items: *429 + items: *437 examples: - default: *375 + default: *382 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55026,8 +55687,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - - *83 - - *210 + - *87 + - *215 responses: '204': description: Response @@ -55052,8 +55713,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *83 - - *210 + - *87 + - *215 responses: '204': description: Response @@ -55084,8 +55745,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - - *83 - - *430 + - *87 + - *438 - *17 - *19 responses: @@ -55093,9 +55754,9 @@ paths: description: Success content: application/json: - schema: *431 + schema: *439 examples: - default: *432 + default: *440 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -55115,7 +55776,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - - *83 + - *87 responses: '200': description: Immutable releases settings response @@ -55164,7 +55825,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#set-immutable-releases-settings-for-an-organization parameters: - - *83 + - *87 responses: '204': description: Response @@ -55221,7 +55882,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - - *83 + - *87 - *19 - *17 responses: @@ -55239,9 +55900,9 @@ paths: type: integer repositories: type: array - items: *274 + items: *281 examples: - default: *288 + default: *295 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55260,7 +55921,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement parameters: - - *83 + - *87 requestBody: required: true content: @@ -55309,8 +55970,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - - *83 - - *268 + - *87 + - *275 responses: '204': description: Response @@ -55332,8 +55993,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - - *83 - - *268 + - *87 + - *275 responses: '204': description: Response @@ -55356,7 +56017,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *83 + - *87 - *17 - *19 responses: @@ -55374,11 +56035,11 @@ paths: type: integer network_configurations: type: array - items: *143 + items: *147 examples: - default: *433 + default: *441 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55397,7 +56058,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization parameters: - - *83 + - *87 requestBody: required: true content: @@ -55439,9 +56100,9 @@ paths: description: Response content: application/json: - schema: *143 + schema: *147 examples: - default: *144 + default: *148 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55461,18 +56122,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - - *83 - - *145 + - *87 + - *149 responses: '200': description: Response content: application/json: - schema: *143 + schema: *147 examples: - default: *144 + default: *148 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55491,8 +56152,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - - *83 - - *145 + - *87 + - *149 requestBody: required: true content: @@ -55531,9 +56192,9 @@ paths: description: Response content: application/json: - schema: *143 + schema: *147 examples: - default: *144 + default: *148 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55552,8 +56213,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - - *83 - - *145 + - *87 + - *149 responses: '204': description: Response @@ -55576,18 +56237,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - - *83 - - *434 + - *87 + - *442 responses: '200': description: Response content: application/json: - schema: *435 + schema: *443 examples: - default: *436 + default: *444 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55604,7 +56265,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-an-organization parameters: - - *83 + - *87 - *17 - name: page description: Page token @@ -55623,7 +56284,7 @@ paths: description: Response content: application/json: - schema: &458 + schema: &464 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -55669,7 +56330,7 @@ paths: type: string nullable: true examples: - default: &459 + default: &465 value: groups: - group_id: '123' @@ -55714,8 +56375,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *83 - - *210 + - *87 + - *215 - 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`). @@ -55747,13 +56408,13 @@ paths: application/json: schema: type: array - items: *202 + items: *207 examples: - default: *203 + default: *208 '500': *40 '403': *29 '404': *6 - '422': *204 + '422': *209 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55771,7 +56432,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - - *83 + - *87 - *17 - *19 responses: @@ -55781,11 +56442,11 @@ paths: application/json: schema: type: array - items: *303 + items: *310 examples: - default: *375 + default: *382 headers: - Link: *43 + Link: *47 '403': *29 x-github: githubCloudOnly: false @@ -55805,7 +56466,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - - *83 + - *87 requestBody: required: true content: @@ -55877,7 +56538,7 @@ paths: description: Response content: application/json: - schema: &437 + schema: &445 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -55940,8 +56601,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *373 - required: *374 + properties: *380 + required: *381 nullable: true members_count: type: integer @@ -56204,7 +56865,7 @@ paths: - repos_count - organization examples: - default: &438 + default: &446 value: id: 1 node_id: MDQ6VGVhbTE= @@ -56274,16 +56935,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - - *83 - - *210 + - *87 + - *215 responses: '200': description: Response content: application/json: - schema: *437 + schema: *445 examples: - default: *438 + default: *446 '404': *6 x-github: githubCloudOnly: false @@ -56304,8 +56965,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - - *83 - - *210 + - *87 + - *215 requestBody: required: false content: @@ -56367,16 +57028,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *437 + schema: *445 examples: - default: *438 + default: *446 '201': description: Response content: application/json: - schema: *437 + schema: *445 examples: - default: *438 + default: *446 '404': *6 '422': *15 '403': *29 @@ -56401,8 +57062,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - - *83 - - *210 + - *87 + - *215 responses: '204': description: Response @@ -56428,9 +57089,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - - *83 - - *210 - - *106 + - *87 + - *215 + - *110 - *17 - *19 - name: pinned @@ -56446,7 +57107,7 @@ paths: application/json: schema: type: array - items: &439 + items: &447 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -56525,7 +57186,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *215 + reactions: *220 required: - author - body @@ -56545,7 +57206,7 @@ paths: - updated_at - url examples: - default: &792 + default: &793 value: - author: login: octocat @@ -56595,7 +57256,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56619,8 +57280,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - - *83 - - *210 + - *87 + - *215 requestBody: required: true content: @@ -56654,9 +57315,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *447 examples: - default: &440 + default: &448 value: author: login: octocat @@ -56728,9 +57389,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - - *83 - - *210 - - &441 + - *87 + - *215 + - &449 name: discussion_number description: The number that identifies the discussion. in: path @@ -56742,9 +57403,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *447 examples: - default: *440 + default: *448 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56766,9 +57427,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - - *83 - - *210 - - *441 + - *87 + - *215 + - *449 requestBody: required: false content: @@ -56791,9 +57452,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *447 examples: - default: &793 + default: &794 value: author: login: octocat @@ -56863,9 +57524,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - - *83 - - *210 - - *441 + - *87 + - *215 + - *449 responses: '204': description: Response @@ -56891,10 +57552,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - - *83 - - *210 - - *441 - - *106 + - *87 + - *215 + - *449 + - *110 - *17 - *19 responses: @@ -56904,7 +57565,7 @@ paths: application/json: schema: type: array - items: &442 + items: &450 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -56961,7 +57622,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *215 + reactions: *220 required: - author - body @@ -56976,7 +57637,7 @@ paths: - updated_at - url examples: - default: &794 + default: &795 value: - author: login: octocat @@ -57020,7 +57681,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57044,9 +57705,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *83 - - *210 - - *441 + - *87 + - *215 + - *449 requestBody: required: true content: @@ -57068,9 +57729,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *450 examples: - default: &443 + default: &451 value: author: login: octocat @@ -57136,10 +57797,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *83 - - *210 - - *441 - - &444 + - *87 + - *215 + - *449 + - &452 name: comment_number description: The number that identifies the comment. in: path @@ -57151,9 +57812,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *450 examples: - default: *443 + default: *451 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57175,10 +57836,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *83 - - *210 - - *441 - - *444 + - *87 + - *215 + - *449 + - *452 requestBody: required: true content: @@ -57200,9 +57861,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *450 examples: - default: &795 + default: &796 value: author: login: octocat @@ -57266,10 +57927,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *83 - - *210 - - *441 - - *444 + - *87 + - *215 + - *449 + - *452 responses: '204': description: Response @@ -57295,10 +57956,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *83 - - *210 - - *441 - - *444 + - *87 + - *215 + - *449 + - *452 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -57324,7 +57985,7 @@ paths: application/json: schema: type: array - items: &445 + items: &453 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -57367,7 +58028,7 @@ paths: - content - created_at examples: - default: &447 + default: &455 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57393,7 +58054,7 @@ paths: content: heart created_at: '2016-05-20T20:09:31Z' headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57417,10 +58078,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *83 - - *210 - - *441 - - *444 + - *87 + - *215 + - *449 + - *452 requestBody: required: true content: @@ -57453,9 +58114,9 @@ paths: team discussion comment content: application/json: - schema: *445 + schema: *453 examples: - default: &446 + default: &454 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57484,9 +58145,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57509,11 +58170,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *83 - - *210 - - *441 - - *444 - - &448 + - *87 + - *215 + - *449 + - *452 + - &456 name: reaction_id description: The unique identifier of the reaction. in: path @@ -57545,9 +58206,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *83 - - *210 - - *441 + - *87 + - *215 + - *449 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -57573,11 +58234,11 @@ paths: application/json: schema: type: array - items: *445 + items: *453 examples: - default: *447 + default: *455 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57601,9 +58262,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *83 - - *210 - - *441 + - *87 + - *215 + - *449 requestBody: required: true content: @@ -57635,16 +58296,16 @@ paths: description: Response content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '201': description: Response content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57667,10 +58328,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *83 - - *210 - - *441 - - *448 + - *87 + - *215 + - *449 + - *456 responses: '204': description: Response @@ -57693,16 +58354,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team parameters: - - *83 - - *210 + - *87 + - *215 responses: '200': description: Response content: application/json: - schema: *449 + schema: *457 examples: - default: *450 + default: *458 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -57721,8 +58382,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team parameters: - - *83 - - *210 + - *87 + - *215 requestBody: required: true content: @@ -57745,9 +58406,9 @@ paths: description: Response content: application/json: - schema: *451 + schema: *459 examples: - default: *452 + default: *460 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -57766,8 +58427,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team parameters: - - *83 - - *210 + - *87 + - *215 responses: '204': description: Response @@ -57791,8 +58452,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - - *83 - - *210 + - *87 + - *215 - *17 - *19 responses: @@ -57802,11 +58463,11 @@ paths: application/json: schema: type: array - items: *357 + items: *364 examples: - default: *358 + default: *365 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57826,8 +58487,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - - *83 - - *210 + - *87 + - *215 - name: role description: Filters members returned by their role in the team. in: query @@ -57850,9 +58511,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57880,15 +58541,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - - *83 - - *210 - - *138 + - *87 + - *215 + - *142 responses: '200': description: Response content: application/json: - schema: &453 + schema: &461 title: Team Membership description: Team Membership type: object @@ -57915,7 +58576,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &796 + response-if-user-is-a-team-maintainer: &797 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -57951,9 +58612,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *83 - - *210 - - *138 + - *87 + - *215 + - *142 requestBody: required: false content: @@ -57978,9 +58639,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *461 examples: - response-if-users-membership-with-team-is-now-pending: &797 + response-if-users-membership-with-team-is-now-pending: &798 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -58015,9 +58676,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - - *83 - - *210 - - *138 + - *87 + - *215 + - *142 responses: '204': description: Response @@ -58028,322 +58689,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/enterprise-cloud@latest//rest/teams/teams#list-team-projects - parameters: - - *83 - - *210 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &454 - 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 - nullable: true - 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: &798 - 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: *43 - 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/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project - parameters: - - *83 - - *210 - - &455 - 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: *454 - examples: - default: &799 - 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/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions - parameters: - - *83 - - *210 - - *455 - 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/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - nullable: true - 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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team - parameters: - - *83 - - *210 - - *455 - 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 @@ -58359,8 +58704,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - - *83 - - *210 + - *87 + - *215 - *17 - *19 responses: @@ -58370,11 +58715,11 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: *382 + default: *389 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58401,16 +58746,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *83 - - *210 - - *456 - - *457 + - *87 + - *215 + - *462 + - *463 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &800 + schema: &799 title: Team Repository description: A team's access to a repository. type: object @@ -58433,8 +58778,8 @@ paths: title: License Simple description: License Simple type: object - properties: *228 - required: *229 + properties: *233 + required: *234 nullable: true forks: type: integer @@ -58979,10 +59324,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *83 - - *210 - - *456 - - *457 + - *87 + - *215 + - *462 + - *463 requestBody: required: false content: @@ -59027,10 +59372,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - - *83 - - *210 - - *456 - - *457 + - *87 + - *215 + - *462 + - *463 responses: '204': description: Response @@ -59056,16 +59401,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team parameters: - - *83 - - *210 + - *87 + - *215 responses: '200': description: Response content: application/json: - schema: *458 + schema: *464 examples: - default: *459 + default: *465 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -59087,8 +59432,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections parameters: - - *83 - - *210 + - *87 + - *215 requestBody: required: true content: @@ -59131,7 +59476,7 @@ paths: description: Response content: application/json: - schema: *458 + schema: *464 examples: default: value: @@ -59163,8 +59508,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - - *83 - - *210 + - *87 + - *215 - *17 - *19 responses: @@ -59174,9 +59519,9 @@ paths: application/json: schema: type: array - items: *303 + items: *310 examples: - response-if-child-teams-exist: &801 + response-if-child-teams-exist: &800 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -59204,7 +59549,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59229,7 +59574,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *83 + - *87 - name: security_product in: path description: The security feature to enable or disable. @@ -59289,979 +59634,6 @@ paths: deprecationDate: '2024-07-22' removalDate: '2025-07-22' deprecated: true - "/projects/columns/cards/{card_id}": - get: - summary: Get a project card - 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-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card - parameters: - - &460 - name: card_id - description: The unique identifier of the card. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: &461 - title: Project Card - description: Project cards represent a scope of work. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/cards/1478 - id: - description: The project card's ID - example: 42 - type: integer - format: int64 - node_id: - type: string - example: MDExOlByb2plY3RDYXJkMTQ3OA== - note: - type: string - example: Add payload for delete Project column - nullable: true - creator: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - created_at: - type: string - format: date-time - example: '2016-09-05T14:21:06Z' - updated_at: - type: string - format: date-time - example: '2016-09-05T14:20:22Z' - archived: - description: Whether or not the card is archived - example: false - type: boolean - column_name: - type: string - project_id: - type: string - column_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - content_url: - type: string - format: uri - example: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - required: - - id - - node_id - - note - - url - - column_url - - project_url - - creator - - created_at - - updated_at - examples: - default: &462 - value: - url: https://api.github.com/projects/columns/cards/1478 - id: 1478 - node_id: MDExOlByb2plY3RDYXJkMTQ3OA== - note: Add payload for delete Project column - 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: '2016-09-05T14:21:06Z' - updated_at: '2016-09-05T14:20:22Z' - archived: false - column_url: https://api.github.com/projects/columns/367 - content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: https://api.github.com/projects/120 - '304': *37 - '403': *29 - '401': *25 - '404': *6 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update an existing project card - 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-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card - parameters: - - *460 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - note: - description: The project card's note - example: Update all gems - type: string - nullable: true - archived: - description: Whether or not the card is archived - example: false - type: boolean - examples: - default: - summary: Change the note on the card - value: - note: Add payload for delete Project column - responses: - '200': - description: Response - content: - application/json: - schema: *461 - examples: - default: *462 - '304': *37 - '403': *29 - '401': *25 - '404': *6 - '422': *7 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete a project card - 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-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card - parameters: - - *460 - responses: - '204': - description: Response - '304': *37 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *25 - '404': *6 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/cards/{card_id}/moves": - post: - summary: Move a project card - 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-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card - parameters: - - *460 - requestBody: - required: true - content: - application/json: - schema: - properties: - position: - description: 'The position of the card in a column. Can be one of: - `top`, `bottom`, or `after:` to place after the specified - card.' - example: bottom - type: string - pattern: "^(?:top|bottom|after:\\d+)$" - column_id: - description: The unique identifier of the column the card should - be moved to - example: 42 - type: integer - required: - - position - type: object - examples: - default: - summary: Move the card to the bottom of the column - value: - column_id: 42 - position: bottom - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': *37 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: object - properties: - code: - type: string - message: - type: string - resource: - type: string - field: - type: string - '401': *25 - '503': - description: Response - content: - application/json: - schema: - type: object - properties: - code: - type: string - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: object - properties: - code: - type: string - message: - type: string - '422': *15 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - 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/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column - parameters: - - &463 - 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: &464 - title: Project Column - description: Project columns contain cards of work. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - cards_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - example: 42 - type: integer - node_id: - type: string - example: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - example: Remaining tasks - type: string - created_at: - type: string - format: date-time - example: '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - example: '2016-09-05T14:22:28Z' - required: - - id - - node_id - - url - - project_url - - cards_url - - name - - created_at - - updated_at - examples: - default: &465 - 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': *37 - '403': *29 - '404': *6 - '401': *25 - 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/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column - parameters: - - *463 - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project column - example: Remaining tasks - type: string - required: - - name - type: object - examples: - default: - summary: Rename the project column - value: - name: To Do - responses: - '200': - description: Response - content: - application/json: - schema: *464 - examples: - default: *465 - '304': *37 - '403': *29 - '401': *25 - 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/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column - parameters: - - *463 - responses: - '204': - description: Response - '304': *37 - '403': *29 - '401': *25 - 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}/cards": - get: - summary: List project cards - 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-cards - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards - parameters: - - *463 - - name: archived_state - description: Filters the project cards that are returned by the card's state. - in: query - required: false - schema: - type: string - enum: - - all - - archived - - not_archived - default: not_archived - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *461 - examples: - default: - value: - - url: https://api.github.com/projects/columns/cards/1478 - id: 1478 - node_id: MDExOlByb2plY3RDYXJkMTQ3OA== - note: Add payload for delete Project column - 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: '2016-09-05T14:21:06Z' - updated_at: '2016-09-05T14:20:22Z' - archived: false - column_url: https://api.github.com/projects/columns/367 - content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: https://api.github.com/projects/120 - headers: - Link: *43 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create a project card - 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/create-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card - parameters: - - *463 - requestBody: - required: true - content: - application/json: - schema: - oneOf: - - type: object - properties: - note: - description: The project card's note - example: Update all gems - type: string - nullable: true - required: - - note - - type: object - properties: - content_id: - description: The unique identifier of the content associated with - the card - example: 42 - type: integer - content_type: - description: The piece of content associated with the card - example: PullRequest - type: string - required: - - content_id - - content_type - examples: - default: - summary: Create a new card - value: - note: Add payload for delete Project column - responses: - '201': - description: Response - content: - application/json: - schema: *461 - examples: - default: *462 - '304': *37 - '403': *29 - '401': *25 - '422': - description: Validation failed - content: - application/json: - schema: - oneOf: - - *249 - - *250 - '503': - description: Response - content: - application/json: - schema: - type: object - properties: - code: - type: string - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: object - properties: - code: - type: string - message: - type: string - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - 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/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column - parameters: - - *463 - 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.' - example: last - type: string - pattern: "^(?:first|last|after:\\d+)$" - 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': *37 - '403': *29 - '422': *7 - '401': *25 - 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/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators - parameters: - - *455 - - 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: *207 - headers: - Link: *43 - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - 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/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator - parameters: - - *455 - - *138 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - example: write - type: string - nullable: true - examples: - default: - summary: Applying write permissions for the new collaborator - value: - permission: write - responses: - '204': - description: Response - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - 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/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator - parameters: - - *455 - - *138 - responses: - '204': - description: Response - '304': *37 - '404': *6 - '403': *29 - '422': *15 - '401': *25 - 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/enterprise-cloud@latest//rest/projects-classic/collaborators#get-project-permission-for-a-user - parameters: - - *455 - - *138 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Project Collaborator Permission - description: Project Collaborator Permission - type: object - properties: - permission: - type: string - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - 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': *37 - '403': *29 - '401': *25 - 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 @@ -60439,8 +59811,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -60969,8 +60341,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: false content: @@ -61259,8 +60631,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -61284,7 +60656,7 @@ paths: documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository '307': *470 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61306,11 +60678,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 - - &485 + - &487 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -61411,7 +60783,7 @@ paths: - expires_at - updated_at examples: - default: &486 + default: &488 value: total_count: 2 artifacts: @@ -61450,7 +60822,7 @@ paths: head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61472,8 +60844,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *456 - - *457 + - *462 + - *463 - &472 name: artifact_id description: The unique identifier of the artifact. @@ -61524,8 +60896,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *456 - - *457 + - *462 + - *463 - *472 responses: '204': @@ -61550,8 +60922,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *456 - - *457 + - *462 + - *463 - *472 - name: archive_format in: path @@ -61566,7 +60938,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': &647 + '410': &649 description: Gone content: application/json: @@ -61576,6 +60948,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/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository + parameters: + - *462 + - *463 + responses: + '200': + description: Response + content: + application/json: + schema: &473 + 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 + example: 14 + examples: + default: *44 + '403': *29 + '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/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository + parameters: + - *462 + - *463 + requestBody: + required: true + content: + application/json: + schema: *473 + examples: + selected_actions: *44 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository + parameters: + - *462 + - *463 + responses: + '200': + description: Response + content: + application/json: + schema: &474 + 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 + example: 10 + examples: + default: *46 + '403': *29 + '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/enterprise-cloud@latest//rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository + parameters: + - *462 + - *463 + requestBody: + required: true + content: + application/json: + schema: *474 + examples: + selected_actions: *46 + responses: + '204': + description: Response + '400': *14 + '403': *29 + '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 @@ -61593,14 +61115,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *473 + schema: *475 examples: default: value: @@ -61626,11 +61148,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 - - &474 + - &476 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 @@ -61658,13 +61180,13 @@ paths: - last_accessed_at - size_in_bytes default: last_accessed_at - - *106 + - *110 responses: '200': description: Response content: application/json: - schema: &475 + schema: &477 title: Repository actions caches description: Repository actions caches type: object @@ -61706,7 +61228,7 @@ paths: - total_count - actions_caches examples: - default: &476 + default: &478 value: total_count: 1 actions_caches: @@ -61718,7 +61240,7 @@ paths: created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61738,23 +61260,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *456 - - *457 + - *462 + - *463 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *474 + - *476 responses: '200': description: Response content: application/json: - schema: *475 + schema: *477 examples: - default: *476 + default: *478 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61774,8 +61296,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *456 - - *457 + - *462 + - *463 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -61806,9 +61328,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *456 - - *457 - - &477 + - *462 + - *463 + - &479 name: job_id description: The unique identifier of the job. in: path @@ -61820,7 +61342,7 @@ paths: description: Response content: application/json: - schema: &489 + schema: &491 title: Job description: Information of a job execution in a workflow run type: object @@ -62127,9 +61649,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *456 - - *457 - - *477 + - *462 + - *463 + - *479 responses: '302': description: Response @@ -62157,9 +61679,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *456 - - *457 - - *477 + - *462 + - *463 + - *479 requestBody: required: false content: @@ -62180,7 +61702,7 @@ paths: description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -62204,8 +61726,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Status response @@ -62255,8 +61777,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -62290,7 +61812,7 @@ paths: description: Empty response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -62319,8 +61841,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -62338,7 +61860,7 @@ paths: type: integer secrets: type: array - items: &491 + items: &493 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -62358,7 +61880,7 @@ paths: - created_at - updated_at examples: - default: &492 + default: &494 value: total_count: 2 secrets: @@ -62369,7 +61891,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62391,9 +61913,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *456 - - *457 - - *478 + - *462 + - *463 + - *480 - *19 responses: '200': @@ -62410,7 +61932,7 @@ paths: type: integer variables: type: array - items: &495 + items: &497 title: Actions Variable type: object properties: @@ -62440,7 +61962,7 @@ paths: - created_at - updated_at examples: - default: &496 + default: &498 value: total_count: 2 variables: @@ -62453,7 +61975,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62473,8 +61995,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -62483,12 +62005,12 @@ paths: schema: type: object properties: - enabled: &479 + enabled: &481 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *56 - selected_actions_url: *261 - sha_pinning_required: *57 + allowed_actions: *60 + selected_actions_url: *268 + sha_pinning_required: *61 required: - enabled examples: @@ -62518,8 +62040,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -62530,9 +62052,9 @@ paths: schema: type: object properties: - enabled: *479 - allowed_actions: *56 - sha_pinning_required: *57 + enabled: *481 + allowed_actions: *60 + sha_pinning_required: *61 required: - enabled examples: @@ -62563,14 +62085,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: &480 + schema: &482 type: object properties: access_level: @@ -62588,7 +62110,7 @@ paths: required: - access_level examples: - default: &481 + default: &483 value: access_level: organization x-github: @@ -62613,15 +62135,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: application/json: - schema: *480 + schema: *482 examples: - default: *481 + default: *483 responses: '204': description: Response @@ -62645,14 +62167,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *263 + schema: *270 examples: default: value: @@ -62676,8 +62198,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Empty response for successful settings update @@ -62687,7 +62209,7 @@ paths: required: true content: application/json: - schema: *264 + schema: *271 examples: default: summary: Set retention days @@ -62711,16 +62233,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *58 + schema: *62 examples: - default: *265 + default: *272 '404': *6 x-github: enabledForGitHubApps: true @@ -62739,8 +62261,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -62750,7 +62272,7 @@ paths: required: true content: application/json: - schema: *58 + schema: *62 examples: default: summary: Set approval policy to first time contributors @@ -62774,16 +62296,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *266 + schema: *273 examples: - default: *59 + default: *63 '403': *29 '404': *6 x-github: @@ -62803,15 +62325,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: application/json: - schema: *267 + schema: *274 examples: - default: *59 + default: *63 responses: '204': description: Empty response for successful settings update @@ -62835,16 +62357,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *61 + schema: *65 examples: - default: *62 + default: *66 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -62867,8 +62389,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -62876,9 +62398,9 @@ paths: required: false content: application/json: - schema: *61 + schema: *65 examples: - selected_actions: *62 + selected_actions: *66 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -62900,16 +62422,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *270 + schema: *277 examples: - default: *65 + default: *69 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62930,8 +62452,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Success response @@ -62942,9 +62464,9 @@ paths: required: true content: application/json: - schema: *271 + schema: *278 examples: - default: *65 + default: *69 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62971,8 +62493,8 @@ paths: in: query schema: type: string - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -62990,11 +62512,11 @@ paths: type: integer runners: type: array - items: *72 + items: *76 examples: - default: *73 + default: *77 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63016,8 +62538,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -63025,9 +62547,9 @@ paths: application/json: schema: type: array - items: *275 + items: *282 examples: - default: *276 + default: *283 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63049,8 +62571,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -63093,10 +62615,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *277 + '201': *284 '404': *6 '422': *7 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63124,16 +62646,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '201': description: Response content: application/json: - schema: *75 + schema: *79 examples: - default: *278 + default: *285 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63161,16 +62683,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '201': description: Response content: application/json: - schema: *75 + schema: *79 examples: - default: *279 + default: *286 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63192,17 +62714,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *456 - - *457 - - *71 + - *462 + - *463 + - *75 responses: '200': description: Response content: application/json: - schema: *72 + schema: *76 examples: - default: *280 + default: *287 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63223,9 +62745,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *456 - - *457 - - *71 + - *462 + - *463 + - *75 responses: '204': description: Response @@ -63251,11 +62773,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *456 - - *457 - - *71 + - *462 + - *463 + - *75 responses: - '200': *77 + '200': *81 '404': *6 x-github: githubCloudOnly: false @@ -63277,9 +62799,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *456 - - *457 - - *71 + - *462 + - *463 + - *75 requestBody: required: true content: @@ -63303,7 +62825,7 @@ paths: - gpu - accelerated responses: - '200': *77 + '200': *81 '404': *6 '422': *7 x-github: @@ -63327,9 +62849,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *456 - - *457 - - *71 + - *462 + - *463 + - *75 requestBody: required: true content: @@ -63354,7 +62876,7 @@ paths: - gpu - accelerated responses: - '200': *77 + '200': *81 '404': *6 '422': *7 x-github: @@ -63378,11 +62900,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *456 - - *457 - - *71 + - *462 + - *463 + - *75 responses: - '200': *281 + '200': *288 '404': *6 x-github: githubCloudOnly: false @@ -63409,12 +62931,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *456 - - *457 - - *71 - - *282 + - *462 + - *463 + - *75 + - *289 responses: - '200': *77 + '200': *81 '404': *6 '422': *7 x-github: @@ -63440,9 +62962,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *456 - - *457 - - &499 + - *462 + - *463 + - &501 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. @@ -63450,7 +62972,7 @@ paths: required: false schema: type: string - - &500 + - &502 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -63458,7 +62980,7 @@ paths: required: false schema: type: string - - &501 + - &503 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -63467,7 +62989,7 @@ paths: required: false schema: type: string - - &502 + - &504 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 @@ -63494,7 +63016,7 @@ paths: - pending - *17 - *19 - - &503 + - &505 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -63503,7 +63025,7 @@ paths: schema: type: string format: date-time - - &482 + - &484 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -63512,13 +63034,13 @@ paths: schema: type: boolean default: false - - &504 + - &506 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &505 + - &507 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -63541,7 +63063,7 @@ paths: type: integer workflow_runs: type: array - items: &483 + items: &485 title: Workflow Run description: An invocation of a workflow type: object @@ -63636,7 +63158,7 @@ paths: that triggered the run. type: array nullable: true - items: &524 + items: &526 title: Pull Request Minimal type: object properties: @@ -63755,7 +63277,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &528 + properties: &530 id: type: string description: SHA for the commit @@ -63806,7 +63328,7 @@ paths: - name - email nullable: true - required: &529 + required: &531 - id - tree_id - message @@ -63814,8 +63336,8 @@ paths: - author - committer nullable: true - repository: *274 - head_repository: *274 + repository: *281 + head_repository: *281 head_repository_id: type: integer example: 5 @@ -63853,7 +63375,7 @@ paths: - workflow_url - pull_requests examples: - default: &506 + default: &508 value: total_count: 1 workflow_runs: @@ -64067,7 +63589,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: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64089,24 +63611,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *456 - - *457 - - &484 + - *462 + - *463 + - &486 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *482 + - *484 responses: '200': description: Response content: application/json: - schema: *483 + schema: *485 examples: - default: &487 + default: &489 value: id: 30433642 name: Build @@ -64347,9 +63869,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 responses: '204': description: Response @@ -64372,9 +63894,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 responses: '200': description: Response @@ -64493,15 +64015,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 responses: '201': description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -64528,12 +64050,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 - *17 - *19 - - *485 + - *487 responses: '200': description: Response @@ -64551,9 +64073,9 @@ paths: type: array items: *471 examples: - default: *486 + default: *488 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64575,25 +64097,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *456 - - *457 - - *484 - - &488 + - *462 + - *463 + - *486 + - &490 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *482 + - *484 responses: '200': description: Response content: application/json: - schema: *483 + schema: *485 examples: - default: *487 + default: *489 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64616,10 +64138,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *456 - - *457 - - *484 - - *488 + - *462 + - *463 + - *486 + - *490 - *17 - *19 responses: @@ -64637,9 +64159,9 @@ paths: type: integer jobs: type: array - items: *489 + items: *491 examples: - default: &490 + default: &492 value: total_count: 1 jobs: @@ -64728,7 +64250,7 @@ paths: workflow_name: CI head_branch: main headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -64752,10 +64274,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *456 - - *457 - - *484 - - *488 + - *462 + - *463 + - *486 + - *490 responses: '302': description: Response @@ -64783,19 +64305,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 responses: '202': description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64818,9 +64340,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 requestBody: required: true content: @@ -64887,19 +64409,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 responses: '202': description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64922,9 +64444,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 - 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 @@ -64954,11 +64476,11 @@ paths: type: integer jobs: type: array - items: *489 + items: *491 examples: - default: *490 + default: *492 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64981,9 +64503,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 responses: '302': description: Response @@ -65010,9 +64532,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 responses: '204': description: Response @@ -65039,9 +64561,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 responses: '200': description: Response @@ -65101,7 +64623,7 @@ paths: items: type: object properties: - type: &613 + type: &615 type: string description: The type of reviewer. enum: @@ -65111,7 +64633,7 @@ paths: reviewer: anyOf: - *4 - - *303 + - *310 required: - environment - wait_timer @@ -65186,9 +64708,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 requestBody: required: true content: @@ -65235,7 +64757,7 @@ paths: application/json: schema: type: array - items: &599 + items: &601 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -65323,8 +64845,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 required: - id - node_id @@ -65341,7 +64863,7 @@ paths: - created_at - updated_at examples: - default: &600 + default: &602 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -65397,9 +64919,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 requestBody: required: false content: @@ -65420,7 +64942,7 @@ paths: description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -65443,9 +64965,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 requestBody: required: false content: @@ -65466,7 +64988,7 @@ paths: description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -65499,9 +65021,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *456 - - *457 - - *484 + - *462 + - *463 + - *486 responses: '200': description: Response @@ -65638,8 +65160,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -65657,11 +65179,11 @@ paths: type: integer secrets: type: array - items: *491 + items: *493 examples: - default: *492 + default: *494 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65684,16 +65206,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *493 + schema: *495 examples: - default: *494 + default: *496 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65715,17 +65237,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *456 - - *457 - - *284 + - *462 + - *463 + - *291 responses: '200': description: Response content: application/json: - schema: *491 + schema: *493 examples: - default: &626 + default: &628 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -65751,9 +65273,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *456 - - *457 - - *284 + - *462 + - *463 + - *291 requestBody: required: true content: @@ -65784,7 +65306,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -65810,9 +65332,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *456 - - *457 - - *284 + - *462 + - *463 + - *291 responses: '204': description: Response @@ -65837,9 +65359,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *456 - - *457 - - *478 + - *462 + - *463 + - *480 - *19 responses: '200': @@ -65856,11 +65378,11 @@ paths: type: integer variables: type: array - items: *495 + items: *497 examples: - default: *496 + default: *498 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65881,8 +65403,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -65909,7 +65431,7 @@ paths: description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -65934,17 +65456,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *456 - - *457 - - *287 + - *462 + - *463 + - *294 responses: '200': description: Response content: application/json: - schema: *495 + schema: *497 examples: - default: &627 + default: &629 value: name: USERNAME value: octocat @@ -65970,9 +65492,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *456 - - *457 - - *287 + - *462 + - *463 + - *294 requestBody: required: true content: @@ -66014,9 +65536,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *456 - - *457 - - *287 + - *462 + - *463 + - *294 responses: '204': description: Response @@ -66041,8 +65563,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -66060,7 +65582,7 @@ paths: type: integer workflows: type: array - items: &497 + items: &499 title: Workflow description: A GitHub Actions workflow type: object @@ -66144,7 +65666,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: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66167,9 +65689,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *456 - - *457 - - &498 + - *462 + - *463 + - &500 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -66184,7 +65706,7 @@ paths: description: Response content: application/json: - schema: *497 + schema: *499 examples: default: value: @@ -66217,9 +65739,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *456 - - *457 - - *498 + - *462 + - *463 + - *500 responses: '204': description: Response @@ -66244,9 +65766,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *456 - - *457 - - *498 + - *462 + - *463 + - *500 responses: '204': description: Response @@ -66297,9 +65819,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *456 - - *457 - - *498 + - *462 + - *463 + - *500 responses: '204': description: Response @@ -66326,19 +65848,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *456 - - *457 - - *498 - - *499 + - *462 + - *463 - *500 - *501 - *502 - - *17 - - *19 - *503 - - *482 - *504 + - *17 + - *19 - *505 + - *484 + - *506 + - *507 responses: '200': description: Response @@ -66354,11 +65876,11 @@ paths: type: integer workflow_runs: type: array - items: *483 + items: *485 examples: - default: *506 + default: *508 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66389,9 +65911,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *456 - - *457 - - *498 + - *462 + - *463 + - *500 responses: '200': description: Response @@ -66452,12 +65974,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *456 - - *457 - - *106 + - *462 + - *463 + - *110 - *17 - - *104 - - *105 + - *108 + - *109 - name: ref description: |- The Git reference for the activities you want to list. @@ -66598,7 +66120,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 '422': *7 x-github: githubCloudOnly: false @@ -66617,8 +66139,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -66630,9 +66152,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -66655,8 +66177,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *456 - - *457 + - *462 + - *463 - name: assignee in: path required: true @@ -66692,8 +66214,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -66805,11 +66327,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *456 - - *457 + - *462 + - *463 - *17 - - *104 - - *105 + - *108 + - *109 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -66863,7 +66385,7 @@ paths: initiator: type: string examples: - default: *507 + default: *509 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66883,8 +66405,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -66892,7 +66414,7 @@ paths: application/json: schema: type: array - items: &508 + items: &510 title: Autolink reference description: An autolink reference. type: object @@ -66946,8 +66468,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -66986,9 +66508,9 @@ paths: description: response content: application/json: - schema: *508 + schema: *510 examples: - default: &509 + default: &511 value: id: 1 key_prefix: TICKET- @@ -67019,9 +66541,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *456 - - *457 - - &510 + - *462 + - *463 + - &512 name: autolink_id description: The unique identifier of the autolink. in: path @@ -67033,9 +66555,9 @@ paths: description: Response content: application/json: - schema: *508 + schema: *510 examples: - default: *509 + default: *511 '404': *6 x-github: githubCloudOnly: false @@ -67055,9 +66577,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *456 - - *457 - - *510 + - *462 + - *463 + - *512 responses: '204': description: Response @@ -67081,8 +66603,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response if Dependabot is enabled @@ -67130,8 +66652,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -67152,8 +66674,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -67173,8 +66695,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *456 - - *457 + - *462 + - *463 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -67212,7 +66734,7 @@ paths: - url protected: type: boolean - protection: &512 + protection: &514 title: Branch Protection description: Branch Protection type: object @@ -67254,7 +66776,7 @@ paths: required: - contexts - checks - enforce_admins: &515 + enforce_admins: &517 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -67269,7 +66791,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &517 + required_pull_request_reviews: &519 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -67290,7 +66812,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *303 + items: *310 apps: description: The list of apps with review dismissal access. @@ -67319,7 +66841,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *303 + items: *310 apps: description: The list of apps allowed to bypass pull request requirements. @@ -67345,7 +66867,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &514 + restrictions: &516 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -67408,7 +66930,7 @@ paths: type: string teams: type: array - items: *303 + items: *310 apps: type: array items: @@ -67604,7 +67126,7 @@ paths: - linter protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -67622,9 +67144,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *456 - - *457 - - &513 + - *462 + - *463 + - &515 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql). @@ -67638,14 +67160,14 @@ paths: description: Response content: application/json: - schema: &523 + schema: &525 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &573 + commit: &575 title: Commit description: Commit type: object @@ -67679,7 +67201,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &511 + properties: &513 name: type: string example: '"Chris Wanstrath"' @@ -67688,13 +67210,14 @@ paths: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true committer: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *511 + properties: *513 nullable: true message: type: string @@ -67715,7 +67238,7 @@ paths: required: - sha - url - verification: &633 + verification: &635 title: Verification type: object properties: @@ -67749,12 +67272,12 @@ paths: nullable: true oneOf: - *4 - - *285 + - *292 committer: nullable: true oneOf: - *4 - - *285 + - *292 parents: type: array items: @@ -67785,7 +67308,7 @@ paths: type: integer files: type: array - items: &586 + items: &588 title: Diff Entry description: Diff Entry type: object @@ -67869,7 +67392,7 @@ paths: - self protected: type: boolean - protection: *512 + protection: *514 protection_url: type: string format: uri @@ -67998,15 +67521,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *512 + schema: *514 examples: default: value: @@ -68200,9 +67723,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -68457,7 +67980,7 @@ paths: url: type: string format: uri - required_status_checks: &520 + required_status_checks: &522 title: Status Check Policy description: Status Check Policy type: object @@ -68533,7 +68056,7 @@ paths: items: *4 teams: type: array - items: *303 + items: *310 apps: type: array items: *5 @@ -68551,7 +68074,7 @@ paths: items: *4 teams: type: array - items: *303 + items: *310 apps: type: array items: *5 @@ -68609,7 +68132,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *514 + restrictions: *516 required_conversation_resolution: type: object properties: @@ -68721,9 +68244,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -68748,17 +68271,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *515 + schema: *517 examples: - default: &516 + default: &518 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -68780,17 +68303,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *515 + schema: *517 examples: - default: *516 + default: *518 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68809,9 +68332,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -68836,17 +68359,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *517 + schema: *519 examples: - default: &518 + default: &520 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -68942,9 +68465,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -69042,9 +68565,9 @@ paths: description: Response content: application/json: - schema: *517 + schema: *519 examples: - default: *518 + default: *520 '422': *15 x-github: githubCloudOnly: false @@ -69065,9 +68588,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -69094,17 +68617,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *515 + schema: *517 examples: - default: &519 + default: &521 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -69127,17 +68650,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *515 + schema: *517 examples: - default: *519 + default: *521 '404': *6 x-github: githubCloudOnly: false @@ -69157,9 +68680,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -69184,17 +68707,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *520 + schema: *522 examples: - default: &521 + default: &523 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -69220,9 +68743,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -69274,9 +68797,9 @@ paths: description: Response content: application/json: - schema: *520 + schema: *522 examples: - default: *521 + default: *523 '404': *6 '422': *15 x-github: @@ -69298,9 +68821,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -69324,9 +68847,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response @@ -69360,9 +68883,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -69429,9 +68952,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -69495,9 +69018,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: content: application/json: @@ -69563,15 +69086,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response content: application/json: - schema: *514 + schema: *516 examples: default: value: @@ -69662,9 +69185,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '204': description: Response @@ -69687,9 +69210,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response @@ -69699,7 +69222,7 @@ paths: type: array items: *5 examples: - default: &522 + default: &524 value: - id: 1 slug: octoapp @@ -69756,9 +69279,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -69792,7 +69315,7 @@ paths: type: array items: *5 examples: - default: *522 + default: *524 '422': *15 x-github: githubCloudOnly: false @@ -69813,9 +69336,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -69849,7 +69372,7 @@ paths: type: array items: *5 examples: - default: *522 + default: *524 '422': *15 x-github: githubCloudOnly: false @@ -69870,9 +69393,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -69906,7 +69429,7 @@ paths: type: array items: *5 examples: - default: *522 + default: *524 '422': *15 x-github: githubCloudOnly: false @@ -69928,9 +69451,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response @@ -69938,9 +69461,9 @@ paths: application/json: schema: type: array - items: *303 + items: *310 examples: - default: *375 + default: *382 '404': *6 x-github: githubCloudOnly: false @@ -69960,9 +69483,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -69998,9 +69521,9 @@ paths: application/json: schema: type: array - items: *303 + items: *310 examples: - default: *375 + default: *382 '422': *15 x-github: githubCloudOnly: false @@ -70021,9 +69544,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: false content: @@ -70059,9 +69582,9 @@ paths: application/json: schema: type: array - items: *303 + items: *310 examples: - default: *375 + default: *382 '422': *15 x-github: githubCloudOnly: false @@ -70082,9 +69605,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: content: application/json: @@ -70119,9 +69642,9 @@ paths: application/json: schema: type: array - items: *303 + items: *310 examples: - default: *375 + default: *382 '422': *15 x-github: githubCloudOnly: false @@ -70143,9 +69666,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 responses: '200': description: Response @@ -70155,7 +69678,7 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 '404': *6 x-github: githubCloudOnly: false @@ -70179,9 +69702,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -70214,7 +69737,7 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 '422': *15 x-github: githubCloudOnly: false @@ -70239,9 +69762,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -70274,7 +69797,7 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 '422': *15 x-github: githubCloudOnly: false @@ -70299,9 +69822,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -70334,7 +69857,7 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 '422': *15 x-github: githubCloudOnly: false @@ -70361,9 +69884,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 requestBody: required: true content: @@ -70385,7 +69908,7 @@ paths: description: Response content: application/json: - schema: *523 + schema: *525 examples: default: value: @@ -70499,12 +70022,12 @@ paths: category: repos subcategory: bypass-requests parameters: - - *456 - - *457 - - *99 - - *100 - - *101 - - *102 + - *462 + - *463 + - *103 + - *104 + - *105 + - *106 - *17 - *19 responses: @@ -70514,9 +70037,9 @@ paths: application/json: schema: type: array - items: *298 + items: *305 examples: - default: *299 + default: *306 '404': *6 '500': *40 "/repos/{owner}/{repo}/bypass-requests/push-rules/{bypass_request_number}": @@ -70536,8 +70059,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *456 - - *457 + - *462 + - *463 - name: bypass_request_number in: path required: true @@ -70551,7 +70074,7 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: default: value: @@ -70610,12 +70133,12 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *456 - - *457 - - *99 - - *100 - - *101 - - *102 + - *462 + - *463 + - *103 + - *104 + - *105 + - *106 - *17 - *19 responses: @@ -70625,9 +70148,9 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *302 + default: *309 '404': *6 '403': *29 '500': *40 @@ -70651,8 +70174,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *456 - - *457 + - *462 + - *463 - name: bypass_request_number in: path required: true @@ -70664,7 +70187,7 @@ paths: description: A single bypass request. content: application/json: - schema: *301 + schema: *308 examples: default: value: @@ -70722,8 +70245,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *456 - - *457 + - *462 + - *463 - name: bypass_request_number in: path required: true @@ -70794,8 +70317,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *456 - - *457 + - *462 + - *463 - name: bypass_response_id in: path required: true @@ -70828,8 +70351,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -71108,7 +70631,7 @@ paths: description: Response content: application/json: - schema: &525 + schema: &527 title: CheckRun description: A check performed on the code of a given code change type: object @@ -71219,16 +70742,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *524 - deployment: &851 + items: *526 + deployment: &859 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -71295,8 +70818,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 required: - id - node_id @@ -71508,9 +71031,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *456 - - *457 - - &526 + - *462 + - *463 + - &528 name: check_run_id description: The unique identifier of the check run. in: path @@ -71522,9 +71045,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *527 examples: - default: &527 + default: &529 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -71624,9 +71147,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *456 - - *457 - - *526 + - *462 + - *463 + - *528 requestBody: required: true content: @@ -71866,9 +71389,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *527 examples: - default: *527 + default: *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71888,9 +71411,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *456 - - *457 - - *526 + - *462 + - *463 + - *528 - *17 - *19 responses: @@ -71965,7 +71488,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: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71985,15 +71508,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *456 - - *457 - - *526 + - *462 + - *463 + - *528 responses: '201': description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -72031,8 +71554,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -72054,7 +71577,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &530 + schema: &532 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -72118,7 +71641,7 @@ paths: nullable: true pull_requests: type: array - items: *524 + items: *526 nullable: true app: title: GitHub app @@ -72129,9 +71652,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 - repository: *274 + properties: *217 + required: *218 + repository: *281 created_at: type: string format: date-time @@ -72140,12 +71663,12 @@ paths: type: string format: date-time nullable: true - head_commit: &882 + head_commit: &890 title: Simple Commit description: A commit. type: object - properties: *528 - required: *529 + properties: *530 + required: *531 latest_check_runs_count: type: integer check_runs_url: @@ -72173,7 +71696,7 @@ paths: - check_runs_url - pull_requests examples: - default: &531 + default: &533 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -72464,9 +71987,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *530 + schema: *532 examples: - default: *531 + default: *533 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72485,8 +72008,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -72547,7 +72070,7 @@ paths: required: - app_id - setting - repository: *274 + repository: *281 examples: default: value: @@ -72795,9 +72318,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *456 - - *457 - - &532 + - *462 + - *463 + - &534 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -72809,9 +72332,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *532 examples: - default: *531 + default: *533 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72834,17 +72357,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *456 - - *457 - - *532 - - &579 + - *462 + - *463 + - *534 + - &581 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &580 + - &582 name: status description: Returns check runs with the specified `status`. in: query @@ -72883,9 +72406,9 @@ paths: type: integer check_runs: type: array - items: *525 + items: *527 examples: - default: &581 + default: &583 value: total_count: 1 check_runs: @@ -72967,7 +72490,7 @@ paths: url: https://api.github.com/repos/github/hello-world name: hello-world headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72987,15 +72510,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *456 - - *457 - - *532 + - *462 + - *463 + - *534 responses: '201': description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -73022,30 +72545,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *456 - - *457 - - *307 - - *308 + - *462 + - *463 + - *314 + - *315 - *19 - *17 - - &548 + - &550 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: *533 - - &549 + schema: *535 + - &551 name: pr description: The number of the pull request for the results you want to list. in: query required: false schema: type: integer - - *106 - - *104 - - *105 + - *110 + - *108 + - *109 - name: sort description: The property by which to sort the results. in: query @@ -73061,13 +72584,13 @@ paths: be returned. in: query required: false - schema: *309 + schema: *316 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *534 + schema: *536 responses: '200': description: Response @@ -73078,14 +72601,14 @@ paths: items: type: object properties: - number: *123 - created_at: *130 - updated_at: *131 - url: *128 - html_url: *129 - instances_url: *535 - state: *109 - fixed_at: *133 + number: *127 + created_at: *134 + updated_at: *135 + url: *132 + html_url: *133 + instances_url: *537 + state: *113 + fixed_at: *137 dismissed_by: title: Simple User description: A GitHub user. @@ -73093,12 +72616,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *132 - dismissed_reason: *536 - dismissed_comment: *537 - rule: *538 - tool: *539 - most_recent_instance: *540 + dismissed_at: *136 + dismissed_reason: *538 + dismissed_comment: *539 + rule: *540 + tool: *541 + most_recent_instance: *542 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -73224,14 +72747,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &541 + '403': &543 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73251,9 +72774,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *456 - - *457 - - &542 + - *462 + - *463 + - &544 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -73261,23 +72784,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *123 + schema: *127 responses: '200': description: Response content: application/json: - schema: &543 + schema: &545 type: object properties: - number: *123 - created_at: *130 - updated_at: *131 - url: *128 - html_url: *129 - instances_url: *535 - state: *109 - fixed_at: *133 + number: *127 + created_at: *134 + updated_at: *135 + url: *132 + html_url: *133 + instances_url: *537 + state: *113 + fixed_at: *137 dismissed_by: title: Simple User description: A GitHub user. @@ -73285,9 +72808,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *132 - dismissed_reason: *536 - dismissed_comment: *537 + dismissed_at: *136 + dismissed_reason: *538 + dismissed_comment: *539 rule: type: object properties: @@ -73341,8 +72864,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *539 - most_recent_instance: *540 + tool: *541 + most_recent_instance: *542 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -73441,9 +72964,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *541 + '403': *543 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73461,9 +72984,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *456 - - *457 - - *542 + - *462 + - *463 + - *544 requestBody: required: true content: @@ -73478,8 +73001,8 @@ paths: enum: - open - dismissed - dismissed_reason: *536 - dismissed_comment: *537 + dismissed_reason: *538 + dismissed_comment: *539 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -73498,7 +73021,7 @@ paths: description: Response content: application/json: - schema: *543 + schema: *545 examples: default: value: @@ -73574,14 +73097,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &547 + '403': &549 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': *190 + '503': *195 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -73601,15 +73124,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *456 - - *457 - - *542 + - *462 + - *463 + - *544 responses: '200': description: Response content: application/json: - schema: &544 + schema: &546 type: object properties: status: @@ -73635,13 +73158,13 @@ paths: - description - started_at examples: - default: &545 + default: &547 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &546 + '400': &548 description: Bad Request content: application/json: @@ -73652,9 +73175,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': *541 + '403': *543 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73677,29 +73200,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *456 - - *457 - - *542 + - *462 + - *463 + - *544 responses: '200': description: OK content: application/json: - schema: *544 + schema: *546 examples: - default: *545 + default: *547 '202': description: Accepted content: application/json: - schema: *544 + schema: *546 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *546 + '400': *548 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -73709,7 +73232,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73731,9 +73254,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *456 - - *457 - - *542 + - *462 + - *463 + - *544 requestBody: required: false content: @@ -73778,12 +73301,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *546 - '403': *547 + '400': *548 + '403': *549 '404': *6 '422': description: Unprocessable Entity - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73803,13 +73326,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *456 - - *457 - - *542 + - *462 + - *463 + - *544 - *19 - *17 - - *548 - - *549 + - *550 + - *551 responses: '200': description: Response @@ -73817,7 +73340,7 @@ paths: application/json: schema: type: array - items: *540 + items: *542 examples: default: value: @@ -73856,9 +73379,9 @@ paths: end_column: 50 classifications: - source - '403': *541 + '403': *543 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73890,29 +73413,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *456 - - *457 - - *307 - - *308 + - *462 + - *463 + - *314 + - *315 - *19 - *17 - - *549 + - *551 - 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: *533 + schema: *535 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &552 + schema: &554 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 - - *106 + - *110 - name: sort description: The property by which to sort the results. in: query @@ -73929,23 +73452,23 @@ paths: application/json: schema: type: array - items: &553 + items: &555 type: object properties: - ref: *533 - commit_sha: &561 + ref: *535 + commit_sha: &563 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: *550 + analysis_key: *552 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *551 + category: *553 error: type: string example: error reading field xyz @@ -73969,8 +73492,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *552 - tool: *539 + sarif_id: *554 + tool: *541 deletable: type: boolean warning: @@ -74031,9 +73554,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *541 + '403': *543 '404': *6 - '503': *190 + '503': *195 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -74067,8 +73590,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -74081,7 +73604,7 @@ paths: description: Response content: application/json: - schema: *553 + schema: *555 examples: response: summary: application/json response @@ -74135,14 +73658,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *541 + '403': *543 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *190 + '503': *195 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -74222,8 +73745,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -74276,9 +73799,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': *547 + '403': *549 '404': *6 - '503': *190 + '503': *195 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -74298,8 +73821,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -74307,7 +73830,7 @@ paths: application/json: schema: type: array - items: &554 + items: &556 title: CodeQL Database description: A CodeQL database. type: object @@ -74418,9 +73941,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': *541 + '403': *543 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74447,8 +73970,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - name: language in: path description: The language of the CodeQL database. @@ -74460,7 +73983,7 @@ paths: description: Response content: application/json: - schema: *554 + schema: *556 examples: default: value: @@ -74492,11 +74015,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': &588 + '302': &590 description: Found - '403': *541 + '403': *543 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74516,8 +74039,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *456 - - *457 + - *462 + - *463 - name: language in: path description: The language of the CodeQL database. @@ -74527,9 +74050,9 @@ paths: responses: '204': description: Response - '403': *547 + '403': *549 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74555,8 +74078,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -74565,7 +74088,7 @@ paths: type: object additionalProperties: false properties: - language: &555 + language: &557 type: string description: The language targeted by the CodeQL query enum: @@ -74645,7 +74168,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &559 + schema: &561 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -74653,9 +74176,9 @@ paths: id: type: integer description: The ID of the variant analysis. - controller_repo: *115 + controller_repo: *119 actor: *4 - query_language: *555 + query_language: *557 query_pack_url: type: string description: The download url for the query pack. @@ -74702,7 +74225,7 @@ paths: items: type: object properties: - repository: &556 + repository: &558 title: Repository Identifier description: Repository Identifier type: object @@ -74738,7 +74261,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &560 + analysis_status: &562 type: string description: The new status of the CodeQL variant analysis repository task. @@ -74770,7 +74293,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &557 + access_mismatch_repos: &559 type: object properties: repository_count: @@ -74784,7 +74307,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: *556 + items: *558 required: - repository_count - repositories @@ -74806,8 +74329,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *557 - over_limit_repos: *557 + no_codeql_db_repos: *559 + over_limit_repos: *559 required: - access_mismatch_repos - not_found_repos @@ -74823,7 +74346,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &558 + value: &560 summary: Default response value: id: 1 @@ -74975,17 +74498,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *558 + value: *560 repository_lists: summary: Response for a successful variant analysis submission - value: *558 + value: *560 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75006,8 +74529,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *456 - - *457 + - *462 + - *463 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -75019,11 +74542,11 @@ paths: description: Response content: application/json: - schema: *559 + schema: *561 examples: - default: *558 + default: *560 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75044,7 +74567,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *456 + - *462 - name: repo in: path description: The name of the controller repository. @@ -75078,8 +74601,8 @@ paths: schema: type: object properties: - repository: *115 - analysis_status: *560 + repository: *119 + analysis_status: *562 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -75183,7 +74706,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75204,8 +74727,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -75290,9 +74813,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *541 + '403': *543 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75311,8 +74834,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -75379,7 +74902,7 @@ paths: description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -75404,7 +74927,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *547 + '403': *549 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -75418,7 +74941,7 @@ paths: content: application/json: schema: *3 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75475,8 +74998,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -75484,7 +75007,7 @@ paths: schema: type: object properties: - commit_sha: *561 + commit_sha: *563 ref: type: string description: |- @@ -75542,7 +75065,7 @@ paths: schema: type: object properties: - id: *552 + id: *554 url: type: string description: The REST API URL for checking the status of the upload. @@ -75556,11 +75079,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': *547 + '403': *549 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *190 + '503': *195 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -75579,8 +75102,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *456 - - *457 + - *462 + - *463 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -75626,10 +75149,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': *541 + '403': *543 '404': description: Not Found if the sarif id does not match any upload - '503': *190 + '503': *195 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -75651,8 +75174,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -75676,7 +75199,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *110 + configuration: *114 examples: default: value: @@ -75708,7 +75231,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': *150 + '204': *154 '304': *37 '403': *29 '404': *6 @@ -75733,8 +75256,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *456 - - *457 + - *462 + - *463 - 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 @@ -75854,8 +75377,8 @@ paths: parameters: - *17 - *19 - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -75871,7 +75394,7 @@ paths: type: integer codespaces: type: array - items: *365 + items: *372 examples: default: value: @@ -76169,8 +75692,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -76233,22 +75756,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '400': *14 '401': *25 '403': *29 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -76272,8 +75795,8 @@ paths: parameters: - *17 - *19 - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -76337,8 +75860,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -76373,14 +75896,14 @@ paths: type: integer machines: type: array - items: &808 + items: &807 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *563 - required: *564 + properties: *565 + required: *566 examples: - default: &809 + default: &808 value: total_count: 2 machines: @@ -76420,8 +75943,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *456 - - *457 + - *462 + - *463 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -76505,8 +76028,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *456 - - *457 + - *462 + - *463 - 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 @@ -76551,7 +76074,7 @@ paths: '403': *29 '404': *6 '422': *15 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76572,8 +76095,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -76591,7 +76114,7 @@ paths: type: integer secrets: type: array - items: &568 + items: &570 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -76611,9 +76134,9 @@ paths: - created_at - updated_at examples: - default: *565 + default: *567 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76634,16 +76157,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *566 + schema: *568 examples: - default: *567 + default: *569 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -76663,17 +76186,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *456 - - *457 - - *284 + - *462 + - *463 + - *291 responses: '200': description: Response content: application/json: - schema: *568 + schema: *570 examples: - default: *569 + default: *571 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76693,9 +76216,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *456 - - *457 - - *284 + - *462 + - *463 + - *291 requestBody: required: true content: @@ -76723,7 +76246,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -76747,9 +76270,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *456 - - *457 - - *284 + - *462 + - *463 + - *291 responses: '204': description: Response @@ -76777,8 +76300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *456 - - *457 + - *462 + - *463 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -76820,7 +76343,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &570 + properties: &572 login: type: string example: octocat @@ -76913,7 +76436,7 @@ paths: user_view_type: type: string example: public - required: &571 + required: &573 - avatar_url - events_url - followers_url @@ -76962,7 +76485,7 @@ paths: admin: false role_name: write headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -76987,9 +76510,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *456 - - *457 - - *138 + - *462 + - *463 + - *142 responses: '204': description: Response if user is a collaborator @@ -77035,9 +76558,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *456 - - *457 - - *138 + - *462 + - *463 + - *142 requestBody: required: false content: @@ -77063,7 +76586,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &646 + schema: &648 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -77074,7 +76597,7 @@ paths: example: 42 type: integer format: int64 - repository: *274 + repository: *281 invitee: title: Simple User description: A GitHub user. @@ -77252,7 +76775,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *249 + schema: *256 '403': *29 x-github: triggersNotification: true @@ -77292,9 +76815,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *456 - - *457 - - *138 + - *462 + - *463 + - *142 responses: '204': description: No Content when collaborator was removed from the repository. @@ -77325,9 +76848,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *456 - - *457 - - *138 + - *462 + - *463 + - *142 responses: '200': description: if user has admin permissions @@ -77347,8 +76870,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *570 - required: *571 + properties: *572 + required: *573 nullable: true required: - permission @@ -77403,8 +76926,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -77414,7 +76937,7 @@ paths: application/json: schema: type: array - items: &572 + items: &574 title: Commit Comment description: Commit Comment type: object @@ -77455,8 +76978,8 @@ paths: updated_at: type: string format: date-time - author_association: *214 - reactions: *215 + author_association: *219 + reactions: *220 required: - url - html_url @@ -77472,7 +76995,7 @@ paths: - created_at - updated_at examples: - default: &575 + default: &577 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77506,7 +77029,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' author_association: COLLABORATOR headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77531,17 +77054,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 responses: '200': description: Response content: application/json: - schema: *572 + schema: *574 examples: - default: &576 + default: &578 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77598,9 +77121,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 requestBody: required: true content: @@ -77622,7 +77145,7 @@ paths: description: Response content: application/json: - schema: *572 + schema: *574 examples: default: value: @@ -77673,9 +77196,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 responses: '204': description: Response @@ -77696,9 +77219,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. @@ -77724,11 +77247,11 @@ paths: application/json: schema: type: array - items: *445 + items: *453 examples: - default: *447 + default: *455 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -77747,9 +77270,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 requestBody: required: true content: @@ -77781,16 +77304,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '201': description: Reaction created content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -77812,10 +77335,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: + - *462 + - *463 + - *231 - *456 - - *457 - - *226 - - *448 responses: '204': description: Response @@ -77864,8 +77387,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *456 - - *457 + - *462 + - *463 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -77921,9 +77444,9 @@ paths: application/json: schema: type: array - items: *573 + items: *575 examples: - default: &699 + default: &701 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -77993,11 +77516,11 @@ paths: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: - Link: *43 + Link: *47 '500': *40 '400': *14 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78017,9 +77540,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *456 - - *457 - - &574 + - *462 + - *463 + - &576 name: commit_sha description: The SHA of the commit. in: path @@ -78066,7 +77589,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78091,9 +77614,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *456 - - *457 - - *574 + - *462 + - *463 + - *576 - *17 - *19 responses: @@ -78103,11 +77626,11 @@ paths: application/json: schema: type: array - items: *572 + items: *574 examples: - default: *575 + default: *577 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78133,9 +77656,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *456 - - *457 - - *574 + - *462 + - *463 + - *576 requestBody: required: true content: @@ -78170,9 +77693,9 @@ paths: description: Response content: application/json: - schema: *572 + schema: *574 examples: - default: *576 + default: *578 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -78200,9 +77723,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *456 - - *457 - - *574 + - *462 + - *463 + - *576 - *17 - *19 responses: @@ -78212,9 +77735,9 @@ paths: application/json: schema: type: array - items: *577 + items: *579 examples: - default: &691 + default: &693 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -78693,8 +78216,8 @@ paths: auto_merge: draft: false headers: - Link: *43 - '409': *114 + Link: *47 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78751,11 +78274,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *456 - - *457 + - *462 + - *463 - *19 - *17 - - &578 + - &580 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)" @@ -78770,9 +78293,9 @@ paths: description: Response content: application/json: - schema: *573 + schema: *575 examples: - default: &676 + default: &678 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -78859,8 +78382,8 @@ paths: '422': *15 '404': *6 '500': *40 - '503': *190 - '409': *114 + '503': *195 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78885,11 +78408,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *456 - - *457 - - *578 - - *579 + - *462 + - *463 - *580 + - *581 + - *582 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -78923,11 +78446,11 @@ paths: type: integer check_runs: type: array - items: *525 + items: *527 examples: - default: *581 + default: *583 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78950,9 +78473,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *456 - - *457 - - *578 + - *462 + - *463 + - *580 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -78960,7 +78483,7 @@ paths: schema: type: integer example: 1 - - *579 + - *581 - *17 - *19 responses: @@ -78978,7 +78501,7 @@ paths: type: integer check_suites: type: array - items: *530 + items: *532 examples: default: value: @@ -79153,7 +78676,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: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79178,9 +78701,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *456 - - *457 - - *578 + - *462 + - *463 + - *580 - *17 - *19 responses: @@ -79247,7 +78770,7 @@ paths: type: string total_count: type: integer - repository: *274 + repository: *281 commit_url: type: string format: uri @@ -79378,9 +78901,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *456 - - *457 - - *578 + - *462 + - *463 + - *580 - *17 - *19 responses: @@ -79390,7 +78913,7 @@ paths: application/json: schema: type: array - items: &753 + items: &754 title: Status description: The status of a commit. type: object @@ -79470,7 +78993,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 '301': *468 x-github: githubCloudOnly: false @@ -79499,8 +79022,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -79529,20 +79052,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *582 - required: *583 + properties: *584 + required: *585 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &584 + properties: &586 url: type: string format: uri html_url: type: string format: uri - required: &585 + required: &587 - url - html_url nullable: true @@ -79550,32 +79073,32 @@ paths: title: License Simple description: License Simple type: object - properties: *228 - required: *229 + properties: *233 + required: *234 nullable: true contributing: title: Community Health File type: object - properties: *584 - required: *585 + properties: *586 + required: *587 nullable: true readme: title: Community Health File type: object - properties: *584 - required: *585 + properties: *586 + required: *587 nullable: true issue_template: title: Community Health File type: object - properties: *584 - required: *585 + properties: *586 + required: *587 nullable: true pull_request_template: title: Community Health File type: object - properties: *584 - required: *585 + properties: *586 + required: *587 nullable: true required: - code_of_conduct @@ -79702,8 +79225,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *456 - - *457 + - *462 + - *463 - *19 - *17 - name: basehead @@ -79746,8 +79269,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *573 - merge_base_commit: *573 + base_commit: *575 + merge_base_commit: *575 status: type: string enum: @@ -79767,10 +79290,10 @@ paths: example: 6 commits: type: array - items: *573 + items: *575 files: type: array - items: *586 + items: *588 required: - url - html_url @@ -80014,7 +79537,7 @@ paths: module Test" '404': *6 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80056,8 +79579,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *456 - - *457 + - *462 + - *463 - name: path description: path parameter in: path @@ -80200,7 +79723,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &587 + response-if-content-is-a-file: &589 summary: Response if content is a file value: type: file @@ -80332,7 +79855,7 @@ paths: - size - type - url - - &704 + - &706 title: Content File description: Content File type: object @@ -80533,7 +80056,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *587 + response-if-content-is-a-file: *589 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -80602,7 +80125,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *588 + '302': *590 '304': *37 x-github: githubCloudOnly: false @@ -80625,8 +80148,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *456 - - *457 + - *462 + - *463 - name: path description: path parameter in: path @@ -80719,7 +80242,7 @@ paths: description: Response content: application/json: - schema: &589 + schema: &591 title: File Commit description: File Commit type: object @@ -80871,7 +80394,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *591 examples: example-for-creating-a-file: value: @@ -80925,7 +80448,7 @@ paths: schema: oneOf: - *3 - - &628 + - &630 description: Repository rule violation was detected type: object properties: @@ -80946,7 +80469,7 @@ paths: items: type: object properties: - placeholder_id: &745 + placeholder_id: &746 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -80978,8 +80501,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *456 - - *457 + - *462 + - *463 - name: path description: path parameter in: path @@ -81040,7 +80563,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *591 examples: default: value: @@ -81074,8 +80597,8 @@ paths: verified_at: '422': *15 '404': *6 - '409': *114 - '503': *190 + '409': *118 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81095,8 +80618,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *456 - - *457 + - *462 + - *463 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -81196,7 +80719,7 @@ paths: site_admin: false contributions: 32 headers: - Link: *43 + Link: *47 '204': description: Response if repository is empty '403': *29 @@ -81219,23 +80742,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *456 - - *457 - - *323 - - *324 - - *325 - - *326 + - *462 + - *463 + - *330 + - *331 + - *332 + - *333 - 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 - - *327 - - *590 - - *328 - - *329 - - *106 + - *334 + - *592 + - *335 + - *336 + - *110 - name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -81244,8 +80767,8 @@ paths: schema: type: integer default: 30 - - *104 - - *105 + - *108 + - *109 responses: '200': description: Response @@ -81253,11 +80776,11 @@ paths: application/json: schema: type: array - items: &593 + items: &595 type: object description: A Dependabot alert. properties: - number: *123 + number: *127 state: type: string description: The state of the Dependabot alert. @@ -81272,7 +80795,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: *124 + package: *128 manifest_path: type: string description: The full path to the dependency manifest file, @@ -81299,13 +80822,13 @@ paths: - unknown - direct - transitive - security_advisory: *591 - security_vulnerability: *127 - url: *128 - html_url: *129 - created_at: *130 - updated_at: *131 - dismissed_at: *132 + security_advisory: *593 + security_vulnerability: *131 + url: *132 + html_url: *133 + created_at: *134 + updated_at: *135 + dismissed_at: *136 dismissed_by: title: Simple User description: A GitHub user. @@ -81329,8 +80852,8 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *133 - auto_dismissed_at: *592 + fixed_at: *137 + auto_dismissed_at: *594 required: - number - state @@ -81560,9 +81083,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *456 - - *457 - - &594 + - *462 + - *463 + - &596 name: alert_number in: path description: |- @@ -81571,13 +81094,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *123 + schema: *127 responses: '200': description: Response content: application/json: - schema: *593 + schema: *595 examples: default: value: @@ -81690,9 +81213,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *456 - - *457 - - *594 + - *462 + - *463 + - *596 requestBody: required: true content: @@ -81737,7 +81260,7 @@ paths: description: Response content: application/json: - schema: *593 + schema: *595 examples: default: value: @@ -81843,7 +81366,7 @@ paths: '400': *14 '403': *29 '404': *6 - '409': *114 + '409': *118 '422': *7 x-github: githubCloudOnly: false @@ -81866,8 +81389,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -81885,7 +81408,7 @@ paths: type: integer secrets: type: array - items: &597 + items: &599 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -81916,7 +81439,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81938,16 +81461,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *595 + schema: *597 examples: - default: *596 + default: *598 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81967,15 +81490,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *456 - - *457 - - *284 + - *462 + - *463 + - *291 responses: '200': description: Response content: application/json: - schema: *597 + schema: *599 examples: default: value: @@ -82001,9 +81524,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *456 - - *457 - - *284 + - *462 + - *463 + - *291 requestBody: required: true content: @@ -82031,7 +81554,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -82055,9 +81578,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *456 - - *457 - - *284 + - *462 + - *463 + - *291 responses: '204': description: Response @@ -82079,8 +81602,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *456 - - *457 + - *462 + - *463 - 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 @@ -82216,7 +81739,7 @@ paths: advisory_summary: Ruby OpenID advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 headers: - Link: *43 + Link: *47 '404': *6 '403': description: Response for a private repository when GitHub Advanced Security @@ -82240,8 +81763,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -82457,7 +81980,7 @@ paths: spdxElementId: SPDXRef-DOCUMENT relatedSpdxElement: SPDXRef-Repository headers: - Link: *43 + Link: *47 '404': *6 '403': *29 x-github: @@ -82480,8 +82003,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -82556,7 +82079,7 @@ paths: - version - url additionalProperties: false - metadata: &598 + metadata: &600 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -82589,7 +82112,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *598 + metadata: *600 resolved: type: object description: A collection of resolved package dependencies. @@ -82602,7 +82125,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *598 + metadata: *600 relationship: type: string description: A notation of whether a dependency is requested @@ -82731,8 +82254,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *456 - - *457 + - *462 + - *463 - name: sha description: The SHA recorded at creation time. in: query @@ -82772,11 +82295,11 @@ paths: application/json: schema: type: array - items: *599 + items: *601 examples: - default: *600 + default: *602 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82840,8 +82363,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -82922,7 +82445,7 @@ paths: description: Response content: application/json: - schema: *599 + schema: *601 examples: simple-example: summary: Simple example @@ -82995,9 +82518,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *456 - - *457 - - &601 + - *462 + - *463 + - &603 name: deployment_id description: deployment_id parameter in: path @@ -83009,7 +82532,7 @@ paths: description: Response content: application/json: - schema: *599 + schema: *601 examples: default: value: @@ -83074,9 +82597,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *456 - - *457 - - *601 + - *462 + - *463 + - *603 responses: '204': description: Response @@ -83098,9 +82621,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *456 - - *457 - - *601 + - *462 + - *463 + - *603 - *17 - *19 responses: @@ -83110,7 +82633,7 @@ paths: application/json: schema: type: array - items: &602 + items: &604 title: Deployment Status description: The status of a deployment. type: object @@ -83201,8 +82724,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 required: - id - node_id @@ -83251,7 +82774,7 @@ paths: environment_url: https://test-branch.lab.acme.com log_url: https://example.com/deployment/42/output headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -83271,9 +82794,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *456 - - *457 - - *601 + - *462 + - *463 + - *603 requestBody: required: true content: @@ -83348,9 +82871,9 @@ paths: description: Response content: application/json: - schema: *602 + schema: *604 examples: - default: &603 + default: &605 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -83406,9 +82929,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *456 - - *457 - - *601 + - *462 + - *463 + - *603 - name: status_id in: path required: true @@ -83419,9 +82942,9 @@ paths: description: Response content: application/json: - schema: *602 + schema: *604 examples: - default: *603 + default: *605 '404': *6 x-github: githubCloudOnly: false @@ -83448,12 +82971,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *456 - - *457 - - *604 - - *605 + - *462 + - *463 - *606 - *607 + - *608 + - *609 - *17 - *19 responses: @@ -83463,9 +82986,9 @@ paths: application/json: schema: type: array - items: *608 + items: *610 examples: - default: *609 + default: *611 '404': *6 '403': *29 '500': *40 @@ -83489,8 +83012,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *456 - - *457 + - *462 + - *463 - name: alert_number in: path required: true @@ -83502,7 +83025,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *608 + schema: *610 examples: default: value: @@ -83558,8 +83081,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *456 - - *457 + - *462 + - *463 - name: alert_number in: path required: true @@ -83618,12 +83141,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *456 - - *457 - - *99 - - *100 - - *101 - - *610 + - *462 + - *463 + - *103 + - *104 + - *105 + - *612 - *17 - *19 responses: @@ -83633,9 +83156,9 @@ paths: application/json: schema: type: array - items: *611 + items: *613 examples: - default: *612 + default: *614 '404': *6 '403': *29 '500': *40 @@ -83660,8 +83183,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *456 - - *457 + - *462 + - *463 - name: alert_number in: path required: true @@ -83673,7 +83196,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *611 + schema: *613 examples: default: value: @@ -83731,8 +83254,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *456 - - *457 + - *462 + - *463 - name: alert_number in: path required: true @@ -83801,8 +83324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -83859,8 +83382,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -83877,7 +83400,7 @@ paths: type: integer environments: type: array - items: &614 + items: &616 title: Environment description: Details of a deployment environment type: object @@ -83929,7 +83452,7 @@ paths: type: type: string example: wait_timer - wait_timer: &616 + wait_timer: &618 type: integer example: 30 description: The amount of time to delay a job after @@ -83966,11 +83489,11 @@ paths: items: type: object properties: - type: *613 + type: *615 reviewer: anyOf: - *4 - - *303 + - *310 required: - id - node_id @@ -83990,7 +83513,7 @@ paths: - id - node_id - type - deployment_branch_policy: &617 + deployment_branch_policy: &619 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -84106,9 +83629,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *456 - - *457 - - &615 + - *462 + - *463 + - &617 name: environment_name in: path required: true @@ -84121,9 +83644,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *616 examples: - default: &618 + default: &620 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -84207,9 +83730,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *456 - - *457 - - *615 + - *462 + - *463 + - *617 requestBody: required: false content: @@ -84218,7 +83741,7 @@ paths: type: object nullable: true properties: - wait_timer: *616 + wait_timer: *618 prevent_self_review: type: boolean example: false @@ -84235,13 +83758,13 @@ paths: items: type: object properties: - type: *613 + type: *615 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *617 + deployment_branch_policy: *619 additionalProperties: false examples: default: @@ -84261,9 +83784,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *616 examples: - default: *618 + default: *620 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -84287,9 +83810,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *456 - - *457 - - *615 + - *462 + - *463 + - *617 responses: '204': description: Default response @@ -84314,9 +83837,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *456 - - *457 - - *615 + - *462 + - *463 + - *617 - *17 - *19 responses: @@ -84334,7 +83857,7 @@ paths: example: 2 branch_policies: type: array - items: &619 + items: &621 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -84391,9 +83914,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *456 - - *457 - - *615 + - *462 + - *463 + - *617 requestBody: required: true content: @@ -84439,9 +83962,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *621 examples: - example-wildcard: &620 + example-wildcard: &622 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -84483,10 +84006,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *456 - - *457 - - *615 - - &621 + - *462 + - *463 + - *617 + - &623 name: branch_policy_id in: path required: true @@ -84498,9 +84021,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *621 examples: - default: *620 + default: *622 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84519,10 +84042,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *456 - - *457 - - *615 - - *621 + - *462 + - *463 + - *617 + - *623 requestBody: required: true content: @@ -84550,9 +84073,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *621 examples: - default: *620 + default: *622 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84571,10 +84094,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *456 - - *457 - - *615 - - *621 + - *462 + - *463 + - *617 + - *623 responses: '204': description: Response @@ -84599,9 +84122,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *615 - - *457 - - *456 + - *617 + - *463 + - *462 responses: '200': description: List of deployment protection rules @@ -84617,7 +84140,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &622 + items: &624 title: Deployment protection rule description: Deployment protection rule type: object @@ -84636,7 +84159,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &623 + app: &625 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -84735,9 +84258,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *615 - - *457 - - *456 + - *617 + - *463 + - *462 requestBody: content: application/json: @@ -84758,9 +84281,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *622 + schema: *624 examples: - default: &624 + default: &626 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -84795,9 +84318,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *615 - - *457 - - *456 + - *617 + - *463 + - *462 - *19 - *17 responses: @@ -84816,7 +84339,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *623 + items: *625 examples: default: value: @@ -84851,10 +84374,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *456 - - *457 - - *615 - - &625 + - *462 + - *463 + - *617 + - &627 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -84866,9 +84389,9 @@ paths: description: Response content: application/json: - schema: *622 + schema: *624 examples: - default: *624 + default: *626 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84889,10 +84412,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *615 - - *457 - - *456 - - *625 + - *617 + - *463 + - *462 + - *627 responses: '204': description: Response @@ -84918,9 +84441,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *456 - - *457 - - *615 + - *462 + - *463 + - *617 - *17 - *19 responses: @@ -84938,11 +84461,11 @@ paths: type: integer secrets: type: array - items: *491 + items: *493 examples: - default: *492 + default: *494 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84965,17 +84488,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *456 - - *457 - - *615 + - *462 + - *463 + - *617 responses: '200': description: Response content: application/json: - schema: *493 + schema: *495 examples: - default: *494 + default: *496 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84997,18 +84520,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *456 - - *457 - - *615 - - *284 + - *462 + - *463 + - *617 + - *291 responses: '200': description: Response content: application/json: - schema: *491 + schema: *493 examples: - default: *626 + default: *628 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85030,10 +84553,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *456 - - *457 - - *615 - - *284 + - *462 + - *463 + - *617 + - *291 requestBody: required: true content: @@ -85064,7 +84587,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -85090,10 +84613,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *456 - - *457 - - *615 - - *284 + - *462 + - *463 + - *617 + - *291 responses: '204': description: Default response @@ -85118,10 +84641,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *456 - - *457 - - *615 - - *478 + - *462 + - *463 + - *617 + - *480 - *19 responses: '200': @@ -85138,11 +84661,11 @@ paths: type: integer variables: type: array - items: *495 + items: *497 examples: - default: *496 + default: *498 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85163,9 +84686,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *456 - - *457 - - *615 + - *462 + - *463 + - *617 requestBody: required: true content: @@ -85192,7 +84715,7 @@ paths: description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -85217,18 +84740,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *456 - - *457 - - *615 - - *287 + - *462 + - *463 + - *617 + - *294 responses: '200': description: Response content: application/json: - schema: *495 + schema: *497 examples: - default: *627 + default: *629 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85249,10 +84772,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *456 - - *457 - - *287 - - *615 + - *462 + - *463 + - *294 + - *617 requestBody: required: true content: @@ -85294,10 +84817,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *456 - - *457 - - *287 - - *615 + - *462 + - *463 + - *294 + - *617 responses: '204': description: Response @@ -85319,8 +84842,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -85330,7 +84853,7 @@ paths: application/json: schema: type: array - items: *239 + items: *244 examples: 200-response: value: @@ -85388,8 +84911,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *456 - - *457 + - *462 + - *463 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -85411,7 +84934,7 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: default: value: @@ -85524,7 +85047,7 @@ paths: url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== headers: - Link: *43 + Link: *47 '400': *14 x-github: githubCloudOnly: false @@ -85548,8 +85071,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: false content: @@ -85604,8 +85127,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -85656,7 +85179,7 @@ paths: schema: type: string '404': *6 - '409': *114 + '409': *118 '403': *29 '422': description: Validation failed @@ -85664,8 +85187,8 @@ paths: application/json: schema: oneOf: - - *249 - - *628 + - *256 + - *630 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85690,8 +85213,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *456 - - *457 + - *462 + - *463 - name: file_sha in: path required: true @@ -85742,7 +85265,7 @@ paths: '404': *6 '422': *15 '403': *29 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85790,8 +85313,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -85900,7 +85423,7 @@ paths: description: Response content: application/json: - schema: &629 + schema: &631 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -86064,7 +85587,7 @@ paths: type: string '422': *15 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86114,15 +85637,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *456 - - *457 - - *574 + - *462 + - *463 + - *576 responses: '200': description: Response content: application/json: - schema: *629 + schema: *631 examples: default: value: @@ -86153,7 +85676,7 @@ paths: payload: verified_at: '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86178,9 +85701,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *456 - - *457 - - &630 + - *462 + - *463 + - &632 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. @@ -86197,7 +85720,7 @@ paths: application/json: schema: type: array - items: &631 + items: &633 title: Git Reference description: Git references within a repository type: object @@ -86250,8 +85773,8 @@ paths: sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: - Link: *43 - '409': *114 + Link: *47 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86272,17 +85795,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *456 - - *457 - - *630 + - *462 + - *463 + - *632 responses: '200': description: Response content: application/json: - schema: *631 + schema: *633 examples: - default: &632 + default: &634 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -86292,7 +85815,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86311,8 +85834,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -86341,16 +85864,16 @@ paths: description: Response content: application/json: - schema: *631 + schema: *633 examples: - default: *632 + default: *634 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86369,9 +85892,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *456 - - *457 - - *630 + - *462 + - *463 + - *632 requestBody: required: true content: @@ -86400,11 +85923,11 @@ paths: description: Response content: application/json: - schema: *631 + schema: *633 examples: - default: *632 + default: *634 '422': *15 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86420,16 +85943,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *456 - - *457 - - *630 + - *462 + - *463 + - *632 responses: '204': description: Response '422': description: Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86477,8 +86000,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -86545,7 +86068,7 @@ paths: description: Response content: application/json: - schema: &634 + schema: &636 title: Git Tag description: Metadata for a Git tag type: object @@ -86596,7 +86119,7 @@ paths: - sha - type - url - verification: *633 + verification: *635 required: - sha - url @@ -86606,7 +86129,7 @@ paths: - tag - message examples: - default: &635 + default: &637 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -86633,7 +86156,7 @@ paths: schema: type: string '422': *15 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86679,8 +86202,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *456 - - *457 + - *462 + - *463 - name: tag_sha in: path required: true @@ -86691,11 +86214,11 @@ paths: description: Response content: application/json: - schema: *634 + schema: *636 examples: - default: *635 + default: *637 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86717,8 +86240,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -86791,7 +86314,7 @@ paths: description: Response content: application/json: - schema: &636 + schema: &638 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -86864,7 +86387,7 @@ paths: '422': *15 '404': *6 '403': *29 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86887,8 +86410,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *456 - - *457 + - *462 + - *463 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -86911,7 +86434,7 @@ paths: description: Response content: application/json: - schema: *636 + schema: *638 examples: default-response: summary: Default response @@ -86952,7 +86475,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86970,8 +86493,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -86981,7 +86504,7 @@ paths: application/json: schema: type: array - items: &637 + items: &639 title: Webhook description: Webhooks for repositories. type: object @@ -87035,7 +86558,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &890 + last_response: &898 title: Hook Response type: object properties: @@ -87090,7 +86613,7 @@ paths: status: unused message: headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -87109,8 +86632,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: false content: @@ -87162,9 +86685,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *639 examples: - default: &638 + default: &640 value: type: Repository id: 12345678 @@ -87212,17 +86735,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 responses: '200': description: Response content: application/json: - schema: *637 + schema: *639 examples: - default: *638 + default: *640 '404': *6 x-github: githubCloudOnly: false @@ -87242,9 +86765,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 requestBody: required: true content: @@ -87289,9 +86812,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *639 examples: - default: *638 + default: *640 '422': *15 '404': *6 x-github: @@ -87312,9 +86835,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 responses: '204': description: Response @@ -87338,9 +86861,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 responses: '200': description: Response @@ -87367,9 +86890,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 requestBody: required: false content: @@ -87413,11 +86936,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 - *17 - - *338 + - *345 responses: '200': description: Response @@ -87425,9 +86948,9 @@ paths: application/json: schema: type: array - items: *339 + items: *346 examples: - default: *340 + default: *347 '400': *14 '422': *15 x-github: @@ -87446,18 +86969,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 - *16 responses: '200': description: Response content: application/json: - schema: *341 + schema: *348 examples: - default: *342 + default: *349 '400': *14 '422': *15 x-github: @@ -87476,9 +86999,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 - *16 responses: '202': *39 @@ -87501,9 +87024,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 responses: '204': description: Response @@ -87528,9 +87051,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *456 - - *457 - - *337 + - *462 + - *463 + - *344 responses: '204': description: Response @@ -87553,8 +87076,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response if immutable releases are enabled @@ -87600,11 +87123,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *456 - - *457 + - *462 + - *463 responses: - '204': *150 - '409': *114 + '204': *154 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87621,11 +87144,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *456 - - *457 + - *462 + - *463 responses: - '204': *150 - '409': *114 + '204': *154 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87679,14 +87202,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: &639 + schema: &641 title: Import description: A repository import from an external source. type: object @@ -87785,7 +87308,7 @@ paths: - html_url - authors_url examples: - default: &642 + default: &644 value: vcs: subversion use_lfs: true @@ -87801,7 +87324,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': &640 + '503': &642 description: Unavailable due to service under maintenance. content: application/json: @@ -87830,8 +87353,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -87879,7 +87402,7 @@ paths: description: Response content: application/json: - schema: *639 + schema: *641 examples: default: value: @@ -87904,7 +87427,7 @@ paths: type: string '422': *15 '404': *6 - '503': *640 + '503': *642 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87932,8 +87455,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: false content: @@ -87982,7 +87505,7 @@ paths: description: Response content: application/json: - schema: *639 + schema: *641 examples: example-1: summary: Example 1 @@ -88030,7 +87553,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': *640 + '503': *642 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88053,12 +87576,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response - '503': *640 + '503': *642 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88084,9 +87607,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *456 - - *457 - - &830 + - *462 + - *463 + - &829 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -88100,7 +87623,7 @@ paths: application/json: schema: type: array - items: &641 + items: &643 title: Porter Author description: Porter Author type: object @@ -88154,7 +87677,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': *640 + '503': *642 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88179,8 +87702,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *456 - - *457 + - *462 + - *463 - name: author_id in: path required: true @@ -88210,7 +87733,7 @@ paths: description: Response content: application/json: - schema: *641 + schema: *643 examples: default: value: @@ -88223,7 +87746,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *640 + '503': *642 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88247,8 +87770,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -88289,7 +87812,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *640 + '503': *642 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88317,8 +87840,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -88345,11 +87868,11 @@ paths: description: Response content: application/json: - schema: *639 + schema: *641 examples: - default: *642 + default: *644 '422': *15 - '503': *640 + '503': *642 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88372,8 +87895,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -88381,7 +87904,7 @@ paths: application/json: schema: *22 examples: - default: *643 + default: *645 '301': *468 '404': *6 x-github: @@ -88402,8 +87925,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -88411,12 +87934,12 @@ paths: application/json: schema: anyOf: - - *355 + - *362 - type: object properties: {} additionalProperties: false examples: - default: &645 + default: &647 value: limit: collaborators_only origin: repository @@ -88441,13 +87964,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: application/json: - schema: *644 + schema: *646 examples: default: summary: Example request body @@ -88459,9 +87982,9 @@ paths: description: Response content: application/json: - schema: *355 + schema: *362 examples: - default: *645 + default: *647 '409': description: Response x-github: @@ -88483,8 +88006,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -88507,8 +88030,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -88518,9 +88041,9 @@ paths: application/json: schema: type: array - items: *646 + items: *648 examples: - default: &823 + default: &822 value: - id: 1 repository: @@ -88634,7 +88157,7 @@ paths: html_url: https://github.com/octocat/Hello-World/invitations node_id: MDQ6VXNlcjE= headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88651,9 +88174,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *456 - - *457 - - *359 + - *462 + - *463 + - *366 requestBody: required: false content: @@ -88682,7 +88205,7 @@ paths: description: Response content: application/json: - schema: *646 + schema: *648 examples: default: value: @@ -88813,9 +88336,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *456 - - *457 - - *359 + - *462 + - *463 + - *366 responses: '204': description: Response @@ -88846,8 +88369,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *456 - - *457 + - *462 + - *463 - 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 @@ -88895,7 +88418,7 @@ paths: required: false schema: type: string - - *363 + - *370 - name: sort description: What to sort results by. in: query @@ -88907,8 +88430,8 @@ paths: - updated - comments default: created - - *106 - - *217 + - *110 + - *222 - *17 - *19 responses: @@ -88918,9 +88441,9 @@ paths: application/json: schema: type: array - items: *227 + items: *232 examples: - default: &656 + default: &658 value: - id: 1 node_id: MDU6SXNzdWUx @@ -89067,7 +88590,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *43 + Link: *47 '301': *468 '422': *15 '404': *6 @@ -89097,8 +88620,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -89180,9 +88703,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: &653 + default: &655 value: id: 1 node_id: MDU6SXNzdWUx @@ -89336,9 +88859,9 @@ paths: '400': *14 '403': *29 '422': *15 - '503': *190 + '503': *195 '404': *6 - '410': *647 + '410': *649 x-github: triggersNotification: true githubCloudOnly: false @@ -89366,9 +88889,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *456 - - *457 - - *237 + - *462 + - *463 + - *242 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -89378,7 +88901,7 @@ paths: enum: - asc - desc - - *217 + - *222 - *17 - *19 responses: @@ -89388,9 +88911,9 @@ paths: application/json: schema: type: array - items: *648 + items: *650 examples: - default: &655 + default: &657 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -89421,7 +88944,7 @@ paths: issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR headers: - Link: *43 + Link: *47 '422': *15 '404': *6 x-github: @@ -89448,17 +88971,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 responses: '200': description: Response content: application/json: - schema: *648 + schema: *650 examples: - default: &649 + default: &651 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -89512,9 +89035,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 requestBody: required: true content: @@ -89536,9 +89059,9 @@ paths: description: Response content: application/json: - schema: *648 + schema: *650 examples: - default: *649 + default: *651 '422': *15 x-github: githubCloudOnly: false @@ -89556,9 +89079,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 responses: '204': description: Response @@ -89578,9 +89101,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. @@ -89606,11 +89129,11 @@ paths: application/json: schema: type: array - items: *445 + items: *453 examples: - default: *447 + default: *455 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -89629,9 +89152,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 requestBody: required: true content: @@ -89663,16 +89186,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '201': description: Reaction created content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -89694,10 +89217,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: + - *462 + - *463 + - *231 - *456 - - *457 - - *226 - - *448 responses: '204': description: Response @@ -89717,8 +89240,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -89728,7 +89251,7 @@ paths: application/json: schema: type: array - items: &652 + items: &654 title: Issue Event description: Issue Event type: object @@ -89771,8 +89294,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *650 - required: *651 + properties: *652 + required: *653 nullable: true label: title: Issue Event Label @@ -89816,7 +89339,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *303 + requested_team: *310 dismissed_review: title: Issue Event Dismissed Review type: object @@ -89881,7 +89404,7 @@ paths: required: - from - to - author_association: *214 + author_association: *219 lock_reason: type: string nullable: true @@ -89894,8 +89417,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 required: - id - node_id @@ -90061,7 +89584,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *43 + Link: *47 '422': *15 x-github: githubCloudOnly: false @@ -90079,8 +89602,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *456 - - *457 + - *462 + - *463 - name: event_id in: path required: true @@ -90091,7 +89614,7 @@ paths: description: Response content: application/json: - schema: *652 + schema: *654 examples: default: value: @@ -90284,7 +89807,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *647 + '410': *649 '403': *29 x-github: githubCloudOnly: false @@ -90318,9 +89841,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *456 - - *457 - - &654 + - *462 + - *463 + - &656 name: issue_number description: The number that identifies the issue. in: path @@ -90332,12 +89855,12 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 '301': *468 '404': *6 - '410': *647 + '410': *649 '304': *37 x-github: githubCloudOnly: false @@ -90362,9 +89885,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: false content: @@ -90468,15 +89991,15 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 '422': *15 - '503': *190 + '503': *195 '403': *29 '301': *468 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90494,9 +90017,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: false content: @@ -90522,9 +90045,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90540,9 +90063,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: content: application/json: @@ -90567,9 +90090,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90591,9 +90114,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - name: assignee in: path required: true @@ -90633,10 +90156,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *456 - - *457 - - *654 - - *217 + - *462 + - *463 + - *656 + - *222 - *17 - *19 responses: @@ -90646,13 +90169,13 @@ paths: application/json: schema: type: array - items: *648 + items: *650 examples: - default: *655 + default: *657 headers: - Link: *43 + Link: *47 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90681,9 +90204,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: true content: @@ -90705,16 +90228,16 @@ paths: description: Response content: application/json: - schema: *648 + schema: *650 examples: - default: *649 + default: *651 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *647 + '410': *649 '422': *15 '404': *6 x-github: @@ -90742,9 +90265,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - *17 - *19 responses: @@ -90754,14 +90277,14 @@ paths: application/json: schema: type: array - items: *227 + items: *232 examples: - default: *656 + default: *658 headers: - Link: *43 + Link: *47 '301': *468 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90789,9 +90312,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: true content: @@ -90813,9 +90336,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by @@ -90823,7 +90346,7 @@ paths: type: string '301': *468 '403': *29 - '410': *647 + '410': *649 '422': *15 '404': *6 x-github: @@ -90854,9 +90377,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -90868,15 +90391,15 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 '301': *468 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *647 + '410': *649 x-github: triggersNotification: true githubCloudOnly: false @@ -90902,9 +90425,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - *17 - *19 responses: @@ -90914,14 +90437,14 @@ paths: application/json: schema: type: array - items: *227 + items: *232 examples: - default: *656 + default: *658 headers: - Link: *43 + Link: *47 '301': *468 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90938,9 +90461,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - *17 - *19 responses: @@ -90954,7 +90477,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &659 + - &661 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -90985,8 +90508,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 label: type: object properties: @@ -91008,7 +90531,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &660 + - &662 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -91039,8 +90562,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 label: type: object properties: @@ -91128,8 +90651,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 assignee: *4 assigner: *4 required: @@ -91144,7 +90667,7 @@ paths: - performed_via_github_app - assignee - assigner - - &661 + - &663 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -91175,8 +90698,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 milestone: type: object properties: @@ -91195,7 +90718,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &662 + - &664 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -91226,8 +90749,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 milestone: type: object properties: @@ -91246,7 +90769,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &663 + - &665 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -91277,8 +90800,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 rename: type: object properties: @@ -91300,7 +90823,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &664 + - &666 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -91331,10 +90854,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 review_requester: *4 - requested_team: *303 + requested_team: *310 requested_reviewer: *4 required: - review_requester @@ -91347,7 +90870,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &665 + - &667 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -91378,10 +90901,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 review_requester: *4 - requested_team: *303 + requested_team: *310 requested_reviewer: *4 required: - review_requester @@ -91394,7 +90917,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &666 + - &668 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -91425,8 +90948,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 dismissed_review: type: object properties: @@ -91454,7 +90977,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &667 + - &669 title: Locked Issue Event description: Locked Issue Event type: object @@ -91485,8 +91008,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 lock_reason: type: string example: '"off-topic"' @@ -91502,7 +91025,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &668 + - &670 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -91533,8 +91056,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 project_card: type: object properties: @@ -91568,7 +91091,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &669 + - &671 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -91599,8 +91122,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 project_card: type: object properties: @@ -91634,7 +91157,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &670 + - &672 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -91665,8 +91188,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 project_card: type: object properties: @@ -91700,7 +91223,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &671 + - &673 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -91790,8 +91313,8 @@ paths: name: label color: red headers: - Link: *43 - '410': *647 + Link: *47 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91808,9 +91331,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - *17 - *19 responses: @@ -91820,7 +91343,7 @@ paths: application/json: schema: type: array - items: &657 + items: &659 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -91867,7 +91390,7 @@ paths: - color - default examples: - default: &658 + default: &660 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -91884,10 +91407,10 @@ paths: color: a2eeef default: false headers: - Link: *43 + Link: *47 '301': *468 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91904,9 +91427,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: false content: @@ -91965,12 +91488,12 @@ paths: application/json: schema: type: array - items: *657 + items: *659 examples: - default: *658 + default: *660 '301': *468 '404': *6 - '410': *647 + '410': *649 '422': *15 x-github: githubCloudOnly: false @@ -91987,9 +91510,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: false content: @@ -92049,12 +91572,12 @@ paths: application/json: schema: type: array - items: *657 + items: *659 examples: - default: *658 + default: *660 '301': *468 '404': *6 - '410': *647 + '410': *649 '422': *15 x-github: githubCloudOnly: false @@ -92071,15 +91594,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 responses: '204': description: Response '301': *468 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92098,9 +91621,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - name: name in: path required: true @@ -92113,7 +91636,7 @@ paths: application/json: schema: type: array - items: *657 + items: *659 examples: default: value: @@ -92126,7 +91649,7 @@ paths: default: true '301': *468 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92146,9 +91669,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: false content: @@ -92176,7 +91699,7 @@ paths: '204': description: Response '403': *29 - '410': *647 + '410': *649 '404': *6 '422': *15 x-github: @@ -92194,9 +91717,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 responses: '204': description: Response @@ -92226,20 +91749,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 responses: '200': description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 '301': *468 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92256,9 +91779,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -92284,13 +91807,13 @@ paths: application/json: schema: type: array - items: *445 + items: *453 examples: - default: *447 + default: *455 headers: - Link: *43 + Link: *47 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92308,9 +91831,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: true content: @@ -92342,16 +91865,16 @@ paths: description: Response content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '201': description: Response content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -92373,10 +91896,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: + - *462 + - *463 + - *656 - *456 - - *457 - - *654 - - *448 responses: '204': description: Response @@ -92405,9 +91928,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: true content: @@ -92429,9 +91952,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -92464,9 +91987,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - *17 - *19 responses: @@ -92476,13 +91999,13 @@ paths: application/json: schema: type: array - items: *227 + items: *232 examples: - default: *656 + default: *658 headers: - Link: *43 + Link: *47 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92510,9 +92033,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: true content: @@ -92539,16 +92062,16 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *647 + '410': *649 '422': *15 '404': *6 x-github: @@ -92568,9 +92091,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 requestBody: required: true content: @@ -92601,13 +92124,13 @@ paths: description: Response content: application/json: - schema: *227 + schema: *232 examples: - default: *653 + default: *655 '403': *29 '404': *6 '422': *7 - '503': *190 + '503': *195 x-github: triggersNotification: true githubCloudOnly: false @@ -92625,9 +92148,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *456 - - *457 - - *654 + - *462 + - *463 + - *656 - *17 - *19 responses: @@ -92642,8 +92165,6 @@ paths: description: Timeline Event type: object anyOf: - - *659 - - *660 - *661 - *662 - *663 @@ -92655,6 +92176,8 @@ paths: - *669 - *670 - *671 + - *672 + - *673 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -92697,7 +92220,7 @@ paths: issue_url: type: string format: uri - author_association: *214 + author_association: *219 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -92707,9 +92230,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 - reactions: *215 + properties: *217 + required: *218 + reactions: *220 required: - event - actor @@ -92740,7 +92263,7 @@ paths: properties: type: type: string - issue: *227 + issue: *232 required: - event - created_at @@ -92940,7 +92463,7 @@ paths: type: string body_text: type: string - author_association: *214 + author_association: *219 required: - event - id @@ -92963,7 +92486,7 @@ paths: type: string comments: type: array - items: &693 + items: &695 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -93052,7 +92575,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *214 + author_association: *219 _links: type: object properties: @@ -93136,7 +92659,7 @@ paths: enum: - line - file - reactions: *215 + reactions: *220 body_html: type: string example: '"

comment body

"' @@ -93172,7 +92695,7 @@ paths: type: string comments: type: array - items: *572 + items: *574 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -93203,8 +92726,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 assignee: *4 required: - id @@ -93247,8 +92770,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 assignee: *4 required: - id @@ -93291,8 +92814,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 state_reason: type: string nullable: true @@ -93459,9 +92982,9 @@ paths: type: User site_admin: true headers: - Link: *43 + Link: *47 '404': *6 - '410': *647 + '410': *649 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93478,8 +93001,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -93489,7 +93012,7 @@ paths: application/json: schema: type: array - items: &672 + items: &674 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -93539,7 +93062,7 @@ paths: last_used: '2022-01-10T15:53:42Z' enabled: true headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93555,8 +93078,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -93592,9 +93115,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *674 examples: - default: &673 + default: &675 value: id: 1 key: ssh-rsa AAA... @@ -93628,9 +93151,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *456 - - *457 - - &674 + - *462 + - *463 + - &676 name: key_id description: The unique identifier of the key. in: path @@ -93642,9 +93165,9 @@ paths: description: Response content: application/json: - schema: *672 + schema: *674 examples: - default: *673 + default: *675 '404': *6 x-github: githubCloudOnly: false @@ -93662,9 +93185,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *456 - - *457 - - *674 + - *462 + - *463 + - *676 responses: '204': description: Response @@ -93684,8 +93207,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -93695,11 +93218,11 @@ paths: application/json: schema: type: array - items: *657 + items: *659 examples: - default: *658 + default: *660 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -93718,8 +93241,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -93755,9 +93278,9 @@ paths: description: Response content: application/json: - schema: *657 + schema: *659 examples: - default: &675 + default: &677 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -93789,8 +93312,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *456 - - *457 + - *462 + - *463 - name: name in: path required: true @@ -93801,9 +93324,9 @@ paths: description: Response content: application/json: - schema: *657 + schema: *659 examples: - default: *675 + default: *677 '404': *6 x-github: githubCloudOnly: false @@ -93820,8 +93343,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *456 - - *457 + - *462 + - *463 - name: name in: path required: true @@ -93860,7 +93383,7 @@ paths: description: Response content: application/json: - schema: *657 + schema: *659 examples: default: value: @@ -93886,8 +93409,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *456 - - *457 + - *462 + - *463 - name: name in: path required: true @@ -93913,8 +93436,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -93950,8 +93473,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '202': *39 '403': @@ -93979,8 +93502,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -94006,9 +93529,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *456 - - *457 - - *548 + - *462 + - *463 + - *550 responses: '200': description: Response @@ -94070,8 +93593,8 @@ paths: title: License Simple description: License Simple type: object - properties: *228 - required: *229 + properties: *233 + required: *234 nullable: true required: - _links @@ -94153,8 +93676,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -94219,8 +93742,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -94254,9 +93777,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *573 + schema: *575 examples: - default: *676 + default: *678 '204': description: Response when already merged '404': @@ -94281,8 +93804,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *456 - - *457 + - *462 + - *463 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -94323,12 +93846,12 @@ paths: application/json: schema: type: array - items: &677 + items: &679 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *395 - required: *396 + properties: *402 + required: *403 examples: default: value: @@ -94367,7 +93890,7 @@ paths: closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -94384,8 +93907,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -94425,9 +93948,9 @@ paths: description: Response content: application/json: - schema: *677 + schema: *679 examples: - default: &678 + default: &680 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -94486,9 +94009,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *456 - - *457 - - &679 + - *462 + - *463 + - &681 name: milestone_number description: The number that identifies the milestone. in: path @@ -94500,9 +94023,9 @@ paths: description: Response content: application/json: - schema: *677 + schema: *679 examples: - default: *678 + default: *680 '404': *6 x-github: githubCloudOnly: false @@ -94519,9 +94042,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *456 - - *457 - - *679 + - *462 + - *463 + - *681 requestBody: required: false content: @@ -94559,9 +94082,9 @@ paths: description: Response content: application/json: - schema: *677 + schema: *679 examples: - default: *678 + default: *680 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94577,9 +94100,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *456 - - *457 - - *679 + - *462 + - *463 + - *681 responses: '204': description: Response @@ -94600,9 +94123,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *456 - - *457 - - *679 + - *462 + - *463 + - *681 - *17 - *19 responses: @@ -94612,11 +94135,11 @@ paths: application/json: schema: type: array - items: *657 + items: *659 examples: - default: *658 + default: *660 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94633,12 +94156,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *456 - - *457 - - *680 - - *681 - - *217 + - *462 + - *463 - *682 + - *683 + - *222 + - *684 - *17 - *19 responses: @@ -94648,11 +94171,11 @@ paths: application/json: schema: type: array - items: *240 + items: *245 examples: - default: *683 + default: *685 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -94674,8 +94197,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: false content: @@ -94733,14 +94256,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: &684 + schema: &686 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -94865,7 +94388,7 @@ paths: - custom_404 - public examples: - default: &685 + default: &687 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -94906,8 +94429,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -94961,11 +94484,11 @@ paths: description: Response content: application/json: - schema: *684 + schema: *686 examples: - default: *685 + default: *687 '422': *15 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94986,8 +94509,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -95073,7 +94596,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95094,14 +94617,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response '422': *15 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95121,8 +94644,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -95132,7 +94655,7 @@ paths: application/json: schema: type: array - items: &686 + items: &688 title: Page Build description: Page Build type: object @@ -95207,7 +94730,7 @@ paths: created_at: '2014-02-10T19:00:49Z' updated_at: '2014-02-10T19:00:51Z' headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95226,8 +94749,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *456 - - *457 + - *462 + - *463 responses: '201': description: Response @@ -95272,16 +94795,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *686 + schema: *688 examples: - default: &687 + default: &689 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -95329,8 +94852,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *456 - - *457 + - *462 + - *463 - name: build_id in: path required: true @@ -95341,9 +94864,9 @@ paths: description: Response content: application/json: - schema: *686 + schema: *688 examples: - default: *687 + default: *689 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95363,8 +94886,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -95469,9 +94992,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *456 - - *457 - - &688 + - *462 + - *463 + - &690 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -95529,11 +95052,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *456 - - *457 - - *688 + - *462 + - *463 + - *690 responses: - '204': *150 + '204': *154 '404': *6 x-github: githubCloudOnly: false @@ -95558,8 +95081,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -95790,7 +95313,7 @@ paths: description: Empty response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -95817,8 +95340,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Private vulnerability reporting status @@ -95855,10 +95378,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: - '204': *150 + '204': *154 '422': *14 x-github: githubCloudOnly: false @@ -95877,10 +95400,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: - '204': *150 + '204': *154 '422': *14 x-github: githubCloudOnly: false @@ -95900,8 +95423,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -95909,9 +95432,9 @@ paths: application/json: schema: type: array - items: *151 + items: *155 examples: - default: *689 + default: *691 '403': *29 '404': *6 x-github: @@ -95933,8 +95456,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -95946,11 +95469,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *151 + items: *155 required: - properties examples: - default: *690 + default: *692 responses: '204': description: No Content when custom property values are successfully created @@ -95988,8 +95511,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *456 - - *457 + - *462 + - *463 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -96049,11 +95572,11 @@ paths: application/json: schema: type: array - items: *577 + items: *579 examples: - default: *691 + default: *693 headers: - Link: *43 + Link: *47 '304': *37 '422': *15 x-github: @@ -96083,8 +95606,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -96149,7 +95672,7 @@ paths: description: Response content: application/json: - schema: &695 + schema: &697 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -96260,8 +95783,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *395 - required: *396 + properties: *402 + required: *403 nullable: true active_lock_reason: type: string @@ -96306,7 +95829,7 @@ paths: nullable: true requested_teams: type: array - items: *429 + items: *437 nullable: true head: type: object @@ -96315,7 +95838,7 @@ paths: type: string ref: type: string - repo: *74 + repo: *78 sha: type: string user: *4 @@ -96332,7 +95855,7 @@ paths: type: string ref: type: string - repo: *74 + repo: *78 sha: type: string user: *4 @@ -96345,14 +95868,14 @@ paths: _links: type: object properties: - comments: *397 - commits: *397 - statuses: *397 - html: *397 - issue: *397 - review_comments: *397 - review_comment: *397 - self: *397 + comments: *404 + commits: *404 + statuses: *404 + html: *404 + issue: *404 + review_comments: *404 + review_comment: *404 + self: *404 required: - comments - commits @@ -96362,8 +95885,8 @@ paths: - review_comments - review_comment - self - author_association: *214 - auto_merge: *692 + author_association: *219 + auto_merge: *694 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -96455,7 +95978,7 @@ paths: - merged_by - review_comments examples: - default: &696 + default: &698 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -96982,8 +96505,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - name: sort in: query required: false @@ -97002,7 +96525,7 @@ paths: enum: - asc - desc - - *217 + - *222 - *17 - *19 responses: @@ -97012,9 +96535,9 @@ paths: application/json: schema: type: array - items: *693 + items: *695 examples: - default: &698 + default: &700 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97066,7 +96589,7 @@ paths: original_line: 2 side: RIGHT headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97091,17 +96614,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 responses: '200': description: Response content: application/json: - schema: *693 + schema: *695 examples: - default: &694 + default: &696 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97176,9 +96699,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 requestBody: required: true content: @@ -97200,9 +96723,9 @@ paths: description: Response content: application/json: - schema: *693 + schema: *695 examples: - default: *694 + default: *696 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97218,9 +96741,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 responses: '204': description: Response @@ -97241,9 +96764,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. @@ -97269,11 +96792,11 @@ paths: application/json: schema: type: array - items: *445 + items: *453 examples: - default: *447 + default: *455 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -97292,9 +96815,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *456 - - *457 - - *226 + - *462 + - *463 + - *231 requestBody: required: true content: @@ -97326,16 +96849,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '201': description: Reaction created content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -97357,10 +96880,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: + - *462 + - *463 + - *231 - *456 - - *457 - - *226 - - *448 responses: '204': description: Response @@ -97403,9 +96926,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *456 - - *457 - - &697 + - *462 + - *463 + - &699 name: pull_number description: The number that identifies the pull request. in: path @@ -97418,9 +96941,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *695 + schema: *697 examples: - default: *696 + default: *698 '304': *37 '404': *6 '406': @@ -97429,7 +96952,7 @@ paths: application/json: schema: *3 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97455,9 +96978,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 requestBody: required: false content: @@ -97499,9 +97022,9 @@ paths: description: Response content: application/json: - schema: *695 + schema: *697 examples: - default: *696 + default: *698 '422': *15 '403': *29 x-github: @@ -97523,9 +97046,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 requestBody: required: true content: @@ -97585,21 +97108,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '401': *25 '403': *29 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97625,10 +97148,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *456 - - *457 - - *697 - - *237 + - *462 + - *463 + - *699 + - *242 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -97638,7 +97161,7 @@ paths: enum: - asc - desc - - *217 + - *222 - *17 - *19 responses: @@ -97648,11 +97171,11 @@ paths: application/json: schema: type: array - items: *693 + items: *695 examples: - default: *698 + default: *700 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97683,9 +97206,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 requestBody: required: true content: @@ -97790,7 +97313,7 @@ paths: description: Response content: application/json: - schema: *693 + schema: *695 examples: example-for-a-multi-line-comment: value: @@ -97878,10 +97401,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *456 - - *457 - - *697 - - *226 + - *462 + - *463 + - *699 + - *231 requestBody: required: true content: @@ -97903,7 +97426,7 @@ paths: description: Response content: application/json: - schema: *693 + schema: *695 examples: default: value: @@ -97989,9 +97512,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 - *17 - *19 responses: @@ -98001,11 +97524,11 @@ paths: application/json: schema: type: array - items: *573 + items: *575 examples: - default: *699 + default: *701 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98033,9 +97556,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 - *17 - *19 responses: @@ -98045,7 +97568,7 @@ paths: application/json: schema: type: array - items: *586 + items: *588 examples: default: value: @@ -98061,10 +97584,10 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" headers: - Link: *43 + Link: *47 '422': *15 '500': *40 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98083,9 +97606,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 responses: '204': description: Response if pull request has been merged @@ -98108,9 +97631,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 requestBody: required: false content: @@ -98221,9 +97744,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 responses: '200': description: Response @@ -98239,7 +97762,7 @@ paths: items: *4 teams: type: array - items: *303 + items: *310 required: - users - teams @@ -98280,7 +97803,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98298,9 +97821,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 requestBody: required: false content: @@ -98337,7 +97860,7 @@ paths: description: Response content: application/json: - schema: *577 + schema: *579 examples: default: value: @@ -98873,9 +98396,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 requestBody: required: true content: @@ -98909,7 +98432,7 @@ paths: description: Response content: application/json: - schema: *577 + schema: *579 examples: default: value: @@ -99414,9 +98937,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 - *17 - *19 responses: @@ -99426,7 +98949,7 @@ paths: application/json: schema: type: array - items: &700 + items: &702 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -99495,7 +99018,7 @@ paths: type: string body_text: type: string - author_association: *214 + author_association: *219 required: - id - node_id @@ -99544,7 +99067,7 @@ paths: commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 author_association: COLLABORATOR headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99577,9 +99100,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 requestBody: required: false content: @@ -99665,9 +99188,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *702 examples: - default: &702 + default: &704 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -99730,10 +99253,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *456 - - *457 - - *697 - - &701 + - *462 + - *463 + - *699 + - &703 name: review_id description: The unique identifier of the review. in: path @@ -99745,9 +99268,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *702 examples: - default: &703 + default: &705 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -99806,10 +99329,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *456 - - *457 - - *697 - - *701 + - *462 + - *463 + - *699 + - *703 requestBody: required: true content: @@ -99832,7 +99355,7 @@ paths: description: Response content: application/json: - schema: *700 + schema: *702 examples: default: value: @@ -99894,18 +99417,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *456 - - *457 - - *697 - - *701 + - *462 + - *463 + - *699 + - *703 responses: '200': description: Response content: application/json: - schema: *700 + schema: *702 examples: - default: *702 + default: *704 '422': *7 '404': *6 x-github: @@ -99932,10 +99455,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *456 - - *457 - - *697 - - *701 + - *462 + - *463 + - *699 + - *703 - *17 - *19 responses: @@ -100014,13 +99537,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *214 + author_association: *219 _links: type: object properties: - self: *397 - html: *397 - pull_request: *397 + self: *404 + html: *404 + pull_request: *404 required: - self - html @@ -100029,7 +99552,7 @@ paths: type: string body_html: type: string - reactions: *215 + reactions: *220 side: description: The side of the first line of the range for a multi-line comment. @@ -100141,7 +99664,7 @@ paths: pull_request: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -100170,10 +99693,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *456 - - *457 - - *697 - - *701 + - *462 + - *463 + - *699 + - *703 requestBody: required: true content: @@ -100201,7 +99724,7 @@ paths: description: Response content: application/json: - schema: *700 + schema: *702 examples: default: value: @@ -100264,10 +99787,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *456 - - *457 - - *697 - - *701 + - *462 + - *463 + - *699 + - *703 requestBody: required: true content: @@ -100302,9 +99825,9 @@ paths: description: Response content: application/json: - schema: *700 + schema: *702 examples: - default: *703 + default: *705 '404': *6 '422': *7 '403': *29 @@ -100326,9 +99849,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *456 - - *457 - - *697 + - *462 + - *463 + - *699 requestBody: required: false content: @@ -100391,8 +99914,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *456 - - *457 + - *462 + - *463 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -100405,9 +99928,9 @@ paths: description: Response content: application/json: - schema: *704 + schema: *706 examples: - default: &705 + default: &707 value: type: file encoding: base64 @@ -100449,8 +99972,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *456 - - *457 + - *462 + - *463 - name: dir description: The alternate path to look for a README file in: path @@ -100470,9 +99993,9 @@ paths: description: Response content: application/json: - schema: *704 + schema: *706 examples: - default: *705 + default: *707 '404': *6 '422': *15 x-github: @@ -100494,8 +100017,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -100505,7 +100028,7 @@ paths: application/json: schema: type: array - items: &706 + items: &708 title: Release description: A release. type: object @@ -100576,7 +100099,7 @@ paths: author: *4 assets: type: array - items: &707 + items: &709 title: Release Asset description: Data related to a release. type: object @@ -100651,7 +100174,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *215 + reactions: *220 required: - assets_url - upload_url @@ -100743,7 +100266,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -100763,8 +100286,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -100840,9 +100363,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *708 examples: - default: &710 + default: &712 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -100947,9 +100470,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *456 - - *457 - - &708 + - *462 + - *463 + - &710 name: asset_id description: The unique identifier of the asset. in: path @@ -100961,9 +100484,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *709 examples: - default: &709 + default: &711 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 @@ -100998,7 +100521,7 @@ paths: type: User site_admin: false '404': *6 - '302': *588 + '302': *590 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101014,9 +100537,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *456 - - *457 - - *708 + - *462 + - *463 + - *710 requestBody: required: false content: @@ -101044,9 +100567,9 @@ paths: description: Response content: application/json: - schema: *707 + schema: *709 examples: - default: *709 + default: *711 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101062,9 +100585,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *456 - - *457 - - *708 + - *462 + - *463 + - *710 responses: '204': description: Response @@ -101088,8 +100611,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -101174,16 +100697,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response content: application/json: - schema: *706 + schema: *708 examples: - default: *710 + default: *712 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101200,8 +100723,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *456 - - *457 + - *462 + - *463 - name: tag description: tag parameter in: path @@ -101214,9 +100737,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *708 examples: - default: *710 + default: *712 '404': *6 x-github: githubCloudOnly: false @@ -101238,9 +100761,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *456 - - *457 - - &711 + - *462 + - *463 + - &713 name: release_id description: The unique identifier of the release. in: path @@ -101254,9 +100777,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *706 + schema: *708 examples: - default: *710 + default: *712 '401': description: Unauthorized x-github: @@ -101274,9 +100797,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *456 - - *457 - - *711 + - *462 + - *463 + - *713 requestBody: required: false content: @@ -101340,9 +100863,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *708 examples: - default: *710 + default: *712 '404': description: Not Found if the discussion category name is invalid content: @@ -101363,9 +100886,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *456 - - *457 - - *711 + - *462 + - *463 + - *713 responses: '204': description: Response @@ -101385,9 +100908,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *456 - - *457 - - *711 + - *462 + - *463 + - *713 - *17 - *19 responses: @@ -101397,7 +100920,7 @@ paths: application/json: schema: type: array - items: *707 + items: *709 examples: default: value: @@ -101434,7 +100957,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101479,9 +101002,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: - - *456 - - *457 - - *711 + - *462 + - *463 + - *713 - name: name in: query required: true @@ -101507,7 +101030,7 @@ paths: description: Response for successful upload content: application/json: - schema: *707 + schema: *709 examples: response-for-successful-upload: value: @@ -101562,9 +101085,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *456 - - *457 - - *711 + - *462 + - *463 + - *713 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -101588,11 +101111,11 @@ paths: application/json: schema: type: array - items: *445 + items: *453 examples: - default: *447 + default: *455 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -101611,9 +101134,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *456 - - *457 - - *711 + - *462 + - *463 + - *713 requestBody: required: true content: @@ -101643,16 +101166,16 @@ paths: description: Reaction exists content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '201': description: Reaction created content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 '422': *15 x-github: githubCloudOnly: false @@ -101674,10 +101197,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: + - *462 + - *463 + - *713 - *456 - - *457 - - *711 - - *448 responses: '204': description: Response @@ -101701,9 +101224,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *456 - - *457 - - *513 + - *462 + - *463 + - *515 - *17 - *19 responses: @@ -101719,8 +101242,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *165 - - &712 + - *169 + - &714 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -101739,69 +101262,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *166 - - *712 - - allOf: - - *167 - - *712 - - allOf: - - *168 - - *712 - - allOf: - - *713 - - *712 - - allOf: - - *169 - - *712 - allOf: - *170 - - *712 + - *714 - allOf: - *171 - - *712 + - *714 - allOf: - *172 - - *712 + - *714 + - allOf: + - *715 + - *714 - allOf: - *173 - - *712 + - *714 - allOf: - *174 - - *712 + - *714 - allOf: - *175 - - *712 + - *714 - allOf: - *176 - - *712 + - *714 - allOf: - *177 - - *712 + - *714 - allOf: - *178 - - *712 + - *714 - allOf: - *179 - - *712 + - *714 - allOf: - *180 - - *712 + - *714 - allOf: - *181 - - *712 + - *714 - allOf: - *182 - - *712 + - *714 - allOf: - *183 - - *712 + - *714 - allOf: - *184 - - *712 + - *714 + - allOf: + - *185 + - *714 + - allOf: + - *186 + - *714 + - allOf: + - *187 + - *714 + - allOf: + - *188 + - *714 - allOf: + - *189 - *714 - - *712 examples: default: value: @@ -101840,8 +101363,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 - name: includes_parents @@ -101852,7 +101375,7 @@ paths: schema: type: boolean default: true - - *715 + - *716 responses: '200': description: Response @@ -101860,7 +101383,7 @@ paths: application/json: schema: type: array - items: *185 + items: *190 examples: default: value: @@ -101907,8 +101430,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - - *457 + - *462 + - *463 requestBody: description: Request body required: true @@ -101928,16 +101451,16 @@ paths: - tag - push default: branch - enforcement: *163 + enforcement: *167 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *164 - conditions: *157 + items: *168 + conditions: *161 rules: type: array description: An array of rules within the ruleset. - items: *716 + items: *717 required: - name - enforcement @@ -101968,9 +101491,9 @@ paths: description: Response content: application/json: - schema: *185 + schema: *190 examples: - default: &725 + default: &726 value: id: 42 name: super cool ruleset @@ -102017,12 +101540,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *456 - - *457 - - *717 - - *101 + - *462 + - *463 - *718 + - *105 - *719 + - *720 - *17 - *19 responses: @@ -102030,9 +101553,9 @@ paths: description: Response content: application/json: - schema: *720 + schema: *721 examples: - default: *721 + default: *722 '404': *6 '500': *40 x-github: @@ -102053,17 +101576,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *456 - - *457 - - *722 + - *462 + - *463 + - *723 responses: '200': description: Response content: application/json: - schema: *723 + schema: *724 examples: - default: *724 + default: *725 '404': *6 '500': *40 x-github: @@ -102091,8 +101614,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - - *457 + - *462 + - *463 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102112,9 +101635,9 @@ paths: description: Response content: application/json: - schema: *185 + schema: *190 examples: - default: *725 + default: *726 '404': *6 '500': *40 put: @@ -102132,8 +101655,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - - *457 + - *462 + - *463 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102158,16 +101681,16 @@ paths: - branch - tag - push - enforcement: *163 + enforcement: *167 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *164 - conditions: *157 + items: *168 + conditions: *161 rules: description: An array of rules within the ruleset. type: array - items: *716 + items: *717 examples: default: value: @@ -102195,9 +101718,9 @@ paths: description: Response content: application/json: - schema: *185 + schema: *190 examples: - default: *725 + default: *726 '404': *6 '500': *40 delete: @@ -102215,8 +101738,8 @@ paths: category: repos subcategory: rules parameters: - - *456 - - *457 + - *462 + - *463 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102239,8 +101762,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 - name: ruleset_id @@ -102256,9 +101779,9 @@ paths: application/json: schema: type: array - items: *189 + items: *194 examples: - default: *414 + default: *421 '404': *6 '500': *40 x-github: @@ -102277,8 +101800,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *456 - - *457 + - *462 + - *463 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102296,7 +101819,7 @@ paths: description: Response content: application/json: - schema: *415 + schema: *422 examples: default: value: @@ -102351,21 +101874,22 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *456 - - *457 - - *416 - - *417 - - *418 - - *419 - - *106 + - *462 + - *463 + - *423 + - *424 + - *425 + - *426 + - *427 + - *110 - *19 - *17 - - *726 - *727 - - *420 - - *421 - - *422 - - *423 + - *728 + - *428 + - *429 + - *430 + - *431 responses: '200': description: Response @@ -102373,11 +101897,11 @@ paths: application/json: schema: type: array - items: &731 + items: &732 type: object properties: - number: *123 - created_at: *130 + number: *127 + created_at: *134 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -102385,15 +101909,15 @@ paths: format: date-time readOnly: true nullable: true - url: *128 - html_url: *129 + url: *132 + html_url: *133 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *728 - resolution: *729 + state: *729 + resolution: *730 resolved_at: type: string format: date-time @@ -102489,7 +102013,7 @@ paths: pull request. ' - oneOf: *730 + oneOf: *731 nullable: true has_more_locations: type: boolean @@ -102616,7 +102140,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102638,16 +102162,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *456 - - *457 - - *542 - - *423 + - *462 + - *463 + - *544 + - *431 responses: '200': description: Response content: application/json: - schema: *731 + schema: *732 examples: default: value: @@ -102678,7 +102202,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102689,6 +102213,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. @@ -102699,9 +102225,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *456 - - *457 - - *542 + - *462 + - *463 + - *544 requestBody: required: true content: @@ -102709,27 +102235,42 @@ paths: schema: type: object properties: - state: *728 - resolution: *729 + state: *729 + resolution: *730 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true + assignee: + description: The username of the user to assign to the alert. Set + to `null` to unassign the alert. + type: string + nullable: true 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: *731 + schema: *732 examples: default: value: @@ -102774,6 +102315,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. @@ -102781,8 +102341,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': *190 + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository + '503': *195 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -102804,9 +102365,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *456 - - *457 - - *542 + - *462 + - *463 + - *544 - *19 - *17 responses: @@ -102817,7 +102378,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &912 + items: &920 type: object properties: type: @@ -102843,7 +102404,6 @@ paths: example: commit details: oneOf: - - *732 - *733 - *734 - *735 @@ -102856,6 +102416,7 @@ paths: - *742 - *743 - *744 + - *745 examples: default: value: @@ -102915,11 +102476,11 @@ paths: details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 headers: - Link: *43 + Link: *47 '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102941,8 +102502,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -102950,14 +102511,14 @@ paths: schema: type: object properties: - reason: &746 + reason: &747 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *745 + placeholder_id: *746 required: - reason - placeholder_id @@ -102974,7 +102535,7 @@ paths: schema: type: object properties: - reason: *746 + reason: *747 expire_at: type: string format: date-time @@ -102997,7 +102558,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *190 + '503': *195 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -103020,13 +102581,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *190 + '503': *195 '200': description: Response content: @@ -103036,7 +102597,7 @@ paths: properties: incremental_scans: type: array - items: &747 + items: &748 description: Information on a single scan performed by secret scanning on the repository type: object @@ -103062,15 +102623,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *747 + items: *748 backfill_scans: type: array - items: *747 + items: *748 custom_pattern_backfill_scans: type: array items: allOf: - - *747 + - *748 - type: object properties: pattern_name: @@ -103140,9 +102701,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *456 - - *457 - - *106 + - *462 + - *463 + - *110 - name: sort description: The property to sort the results by. in: query @@ -103154,8 +102715,8 @@ paths: - updated - published default: created - - *104 - - *105 + - *108 + - *109 - name: per_page description: The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -103185,9 +102746,9 @@ paths: application/json: schema: type: array - items: *748 + items: *749 examples: - default: *749 + default: *750 '400': *14 '404': *6 x-github: @@ -103210,8 +102771,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -103284,7 +102845,7 @@ paths: login: type: string description: The username of the user credited. - type: *428 + type: *436 required: - login - type @@ -103371,9 +102932,9 @@ paths: description: Response content: application/json: - schema: *748 + schema: *749 examples: - default: &751 + default: &752 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -103606,8 +103167,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -103711,7 +103272,7 @@ paths: description: Response content: application/json: - schema: *748 + schema: *749 examples: default: value: @@ -103858,17 +103419,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *456 - - *457 - - *750 + - *462 + - *463 + - *751 responses: '200': description: Response content: application/json: - schema: *748 + schema: *749 examples: - default: *751 + default: *752 '403': *29 '404': *6 x-github: @@ -103892,9 +103453,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *456 - - *457 - - *750 + - *462 + - *463 + - *751 requestBody: required: true content: @@ -103967,7 +103528,7 @@ paths: login: type: string description: The username of the user credited. - type: *428 + type: *436 required: - login - type @@ -104053,17 +103614,17 @@ paths: description: Response content: application/json: - schema: *748 + schema: *749 examples: - default: *751 - add_credit: *751 + default: *752 + add_credit: *752 '403': *29 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *249 + schema: *256 examples: invalid_state_transition: value: @@ -104094,9 +103655,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *456 - - *457 - - *750 + - *462 + - *463 + - *751 responses: '202': *39 '400': *14 @@ -104123,9 +103684,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *456 - - *457 - - *750 + - *462 + - *463 + - *751 responses: '202': description: Response @@ -104159,8 +103720,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -104237,7 +103798,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 '422': *15 x-github: githubCloudOnly: false @@ -104259,8 +103820,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -104269,7 +103830,7 @@ paths: application/json: schema: type: array - items: &752 + items: &753 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -104282,7 +103843,7 @@ paths: - 1124 - -435 '202': *39 - '204': *150 + '204': *154 '422': description: Repository contains more than 10,000 commits x-github: @@ -104302,8 +103863,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -104352,7 +103913,7 @@ paths: total: 89 week: 1336280400 '202': *39 - '204': *150 + '204': *154 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104379,8 +103940,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -104454,7 +104015,7 @@ paths: d: 77 c: 10 '202': *39 - '204': *150 + '204': *154 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104476,8 +104037,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -104631,8 +104192,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -104642,7 +104203,7 @@ paths: application/json: schema: type: array - items: *752 + items: *753 examples: default: value: @@ -104655,7 +104216,7 @@ paths: - - 0 - 2 - 21 - '204': *150 + '204': *154 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104675,8 +104236,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *456 - - *457 + - *462 + - *463 - name: sha in: path required: true @@ -104730,7 +104291,7 @@ paths: description: Response content: application/json: - schema: *753 + schema: *754 examples: default: value: @@ -104784,8 +104345,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -104797,9 +104358,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104817,14 +104378,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &754 + schema: &755 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -104892,8 +104453,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: false content: @@ -104919,7 +104480,7 @@ paths: description: Response content: application/json: - schema: *754 + schema: *755 examples: default: value: @@ -104946,8 +104507,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -104967,8 +104528,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -105024,7 +104585,7 @@ paths: tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -105047,8 +104608,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -105056,7 +104617,7 @@ paths: application/json: schema: type: array - items: &755 + items: &756 title: Tag protection description: Tag protection type: object @@ -105108,8 +104669,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -105132,7 +104693,7 @@ paths: description: Response content: application/json: - schema: *755 + schema: *756 examples: default: value: @@ -105163,8 +104724,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -105201,8 +104762,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *456 - - *457 + - *462 + - *463 - name: ref in: path required: true @@ -105238,8 +104799,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *456 - - *457 + - *462 + - *463 - *17 - *19 responses: @@ -105249,11 +104810,11 @@ paths: application/json: schema: type: array - items: *303 + items: *310 examples: - default: *375 + default: *382 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -105271,8 +104832,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *456 - - *457 + - *462 + - *463 - *19 - *17 responses: @@ -105280,7 +104841,7 @@ paths: description: Response content: application/json: - schema: &756 + schema: &757 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -105292,7 +104853,7 @@ paths: required: - names examples: - default: &757 + default: &758 value: names: - octocat @@ -105315,8 +104876,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -105347,9 +104908,9 @@ paths: description: Response content: application/json: - schema: *756 + schema: *757 examples: - default: *757 + default: *758 '404': *6 '422': *7 x-github: @@ -105370,9 +104931,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *456 - - *457 - - &758 + - *462 + - *463 + - &759 name: per description: The time frame to display results for. in: query @@ -105401,7 +104962,7 @@ paths: example: 128 clones: type: array - items: &759 + items: &760 title: Traffic type: object properties: @@ -105488,8 +105049,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -105579,8 +105140,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *456 - - *457 + - *462 + - *463 responses: '200': description: Response @@ -105640,9 +105201,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *456 - - *457 - - *758 + - *462 + - *463 + - *759 responses: '200': description: Response @@ -105661,7 +105222,7 @@ paths: example: 3782 views: type: array - items: *759 + items: *760 required: - uniques - count @@ -105738,8 +105299,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *456 - - *457 + - *462 + - *463 requestBody: required: true content: @@ -105775,7 +105336,7 @@ paths: description: Response content: application/json: - schema: *274 + schema: *281 examples: default: value: @@ -106013,8 +105574,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -106037,8 +105598,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -106060,8 +105621,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -106087,8 +105648,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *456 - - *457 + - *462 + - *463 - name: ref in: path required: true @@ -106223,7 +105784,7 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: default: value: @@ -106333,7 +105894,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &767 + - &768 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -106342,7 +105903,7 @@ paths: schema: type: string example: members - - &772 + - &773 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -106353,7 +105914,7 @@ paths: default: 1 format: int32 example: 1 - - &773 + - &774 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -106395,7 +105956,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &762 + items: &763 allOf: - type: object required: @@ -106470,7 +106031,7 @@ paths: - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 - meta: &774 + meta: &775 type: object description: The metadata associated with the creation/updates to the user. @@ -106530,30 +106091,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &763 + '400': &764 description: Bad request content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '401': *761 - '403': &764 + schema: *761 + '401': *762 + '403': &765 description: Permission denied - '429': &765 + '429': &766 description: Too many requests content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '500': &766 + schema: *761 + '500': &767 description: Internal server error content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 + schema: *761 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106577,7 +106138,7 @@ paths: required: true content: application/json: - schema: &770 + schema: &771 type: object required: - schemas @@ -106637,9 +106198,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *762 + schema: *763 examples: - group: &768 + group: &769 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -106658,13 +106219,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *763 - '401': *761 - '403': *764 - '409': &771 + '400': *764 + '401': *762 + '403': *765 + '409': &772 description: Duplicate record detected - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106681,7 +106242,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - - &769 + - &770 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -106689,22 +106250,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *767 + - *768 - *41 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *762 + schema: *763 examples: - default: *768 - '400': *763 - '401': *761 - '403': *764 + default: *769 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106723,13 +106284,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - - *769 + - *770 - *41 requestBody: required: true content: application/json: - schema: *770 + schema: *771 examples: group: summary: Group @@ -106755,17 +106316,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *762 + schema: *763 examples: - group: *768 - groupWithMembers: *768 - '400': *763 - '401': *761 - '403': *764 + group: *769 + groupWithMembers: *769 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106789,13 +106350,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - - *769 + - *770 - *41 requestBody: required: true content: application/json: - schema: &781 + schema: &782 type: object required: - Operations @@ -106855,17 +106416,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *762 + schema: *763 examples: - updateGroup: *768 - addMembers: *768 - '400': *763 - '401': *761 - '403': *764 + updateGroup: *769 + addMembers: *769 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106881,17 +106442,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - - *769 + - *770 - *41 responses: '204': description: Group was deleted, no content - '400': *763 - '401': *761 - '403': *764 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106925,8 +106486,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *772 - *773 + - *774 - *41 responses: '200': @@ -106959,7 +106520,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &776 + items: &777 allOf: - type: object required: @@ -107038,7 +106599,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &775 + roles: &776 type: array description: The roles assigned to the user. items: @@ -107094,7 +106655,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *774 + meta: *775 startIndex: type: integer description: A starting index for the returned page @@ -107131,11 +106692,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *763 - '401': *761 - '403': *764 - '429': *765 - '500': *766 + '400': *764 + '401': *762 + '403': *765 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107159,7 +106720,7 @@ paths: required: true content: application/json: - schema: &779 + schema: &780 type: object required: - schemas @@ -107241,9 +106802,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *775 + roles: *776 examples: - user: &780 + user: &781 summary: User value: schemas: @@ -107290,9 +106851,9 @@ paths: description: User has been created content: application/scim+json: - schema: *776 + schema: *777 examples: - user: &777 + user: &778 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -107318,13 +106879,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 - enterpriseOwner: *777 - '400': *763 - '401': *761 - '403': *764 - '409': *771 - '429': *765 - '500': *766 + enterpriseOwner: *778 + '400': *764 + '401': *762 + '403': *765 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107341,7 +106902,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - - &778 + - &779 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -107354,15 +106915,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *776 + schema: *777 examples: - default: *777 - '400': *763 - '401': *761 - '403': *764 + default: *778 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107384,30 +106945,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - - *778 + - *779 - *41 requestBody: required: true content: application/json: - schema: *779 + schema: *780 examples: - user: *780 + user: *781 responses: '200': description: User was updated content: application/scim+json: - schema: *776 + schema: *777 examples: - user: *777 - '400': *763 - '401': *761 - '403': *764 + user: *778 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107442,13 +107003,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - - *778 + - *779 - *41 requestBody: required: true content: application/json: - schema: *781 + schema: *782 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -107488,18 +107049,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *776 + schema: *777 examples: - userMultiValuedProperties: *777 - userSingleValuedProperties: *777 - disableUser: *777 - '400': *763 - '401': *761 - '403': *764 + userMultiValuedProperties: *778 + userSingleValuedProperties: *778 + disableUser: *778 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '409': *771 - '429': *765 - '500': *766 + '409': *772 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107519,17 +107080,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - - *778 + - *779 - *41 responses: '204': description: User was deleted, no content - '400': *763 - '401': *761 - '403': *764 + '400': *764 + '401': *762 + '403': *765 '404': *6 - '429': *765 - '500': *766 + '429': *766 + '500': *767 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107562,7 +107123,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - - *83 + - *87 - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query @@ -107616,7 +107177,7 @@ paths: example: 1 Resources: type: array - items: &782 + items: &783 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -107847,22 +107408,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *37 - '404': &783 + '404': &784 description: Resource not found content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '403': &784 + schema: *761 + '403': &785 description: Forbidden content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '400': *763 - '429': *765 + schema: *761 + '400': *764 + '429': *766 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -107882,15 +107443,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - - *83 + - *87 responses: '201': description: Response content: application/scim+json: - schema: *782 + schema: *783 examples: - default: &785 + default: &786 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -107913,17 +107474,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *37 - '404': *783 - '403': *784 - '500': *766 + '404': *784 + '403': *785 + '500': *767 '409': description: Conflict content: application/json: - schema: *760 + schema: *761 application/scim+json: - schema: *760 - '400': *763 + schema: *761 + '400': *764 requestBody: required: true content: @@ -108020,18 +107581,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - - *83 - - *778 + - *87 + - *779 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *783 examples: - default: *785 - '404': *783 - '403': *784 + default: *786 + '404': *784 + '403': *785 '304': *37 x-github: githubCloudOnly: true @@ -108054,19 +107615,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - - *83 - - *778 + - *87 + - *779 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *783 examples: - default: *785 + default: *786 '304': *37 - '404': *783 - '403': *784 + '404': *784 + '403': *785 requestBody: required: true content: @@ -108178,20 +107739,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - - *83 - - *778 + - *87 + - *779 responses: '200': description: Response content: application/scim+json: - schema: *782 + schema: *783 examples: - default: *785 + default: *786 '304': *37 - '404': *783 - '403': *784 - '400': *763 + '404': *784 + '403': *785 + '400': *764 '429': description: Response content: @@ -108281,13 +107842,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - - *83 - - *778 + - *87 + - *779 responses: '204': description: Response - '404': *783 - '403': *784 + '404': *784 + '403': *785 '304': *37 x-github: githubCloudOnly: true @@ -108402,7 +107963,7 @@ paths: html_url: type: string format: uri - repository: *274 + repository: *281 score: type: number file_size: @@ -108420,7 +107981,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &786 + text_matches: &787 title: Search Result Text Matches type: array items: @@ -108534,7 +108095,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *190 + '503': *195 '422': *15 '403': *29 x-github: @@ -108583,7 +108144,7 @@ paths: enum: - author-date - committer-date - - &787 + - &788 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 @@ -108654,7 +108215,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *511 + properties: *513 nullable: true comment_count: type: integer @@ -108674,7 +108235,7 @@ paths: url: type: string format: uri - verification: *633 + verification: *635 required: - author - committer @@ -108693,7 +108254,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *511 + properties: *513 nullable: true parents: type: array @@ -108706,12 +108267,12 @@ paths: type: string sha: type: string - repository: *274 + repository: *281 score: type: number node_id: type: string - text_matches: *786 + text_matches: *787 required: - sha - node_id @@ -108904,7 +108465,7 @@ paths: - interactions - created - updated - - *787 + - *788 - *17 - *19 - name: advanced_search @@ -109001,11 +108562,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: type: string state_reason: @@ -109022,8 +108583,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *395 - required: *396 + properties: *402 + required: *403 nullable: true comments: type: integer @@ -109037,7 +108598,7 @@ paths: type: string format: date-time nullable: true - text_matches: *786 + text_matches: *787 pull_request: type: object properties: @@ -109070,10 +108631,10 @@ paths: type: string score: type: number - author_association: *214 + author_association: *219 draft: type: boolean - repository: *74 + repository: *78 body_html: type: string body_text: @@ -109081,7 +108642,7 @@ paths: timeline_url: type: string format: uri - type: *360 + type: *367 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -109091,9 +108652,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 - reactions: *215 + properties: *217 + required: *218 + reactions: *220 required: - assignee - closed_at @@ -109209,7 +108770,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *190 + '503': *195 '422': *15 '304': *37 '403': *29 @@ -109262,7 +108823,7 @@ paths: enum: - created - updated - - *787 + - *788 - *17 - *19 responses: @@ -109306,7 +108867,7 @@ paths: nullable: true score: type: number - text_matches: *786 + text_matches: *787 required: - id - node_id @@ -109392,7 +108953,7 @@ paths: - forks - help-wanted-issues - updated - - *787 + - *788 - *17 - *19 responses: @@ -109611,8 +109172,8 @@ paths: title: License Simple description: License Simple type: object - properties: *228 - required: *229 + properties: *233 + required: *234 nullable: true permissions: type: object @@ -109631,7 +109192,7 @@ paths: - admin - pull - push - text_matches: *786 + text_matches: *787 temp_clone_token: type: string allow_merge_commit: @@ -109833,7 +109394,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *190 + '503': *195 '422': *15 '304': *37 x-github: @@ -109932,7 +109493,7 @@ paths: type: string format: uri nullable: true - text_matches: *786 + text_matches: *787 related: type: array nullable: true @@ -110125,7 +109686,7 @@ paths: - followers - repositories - joined - - *787 + - *788 - *17 - *19 responses: @@ -110229,7 +109790,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *786 + text_matches: *787 blog: type: string nullable: true @@ -110288,7 +109849,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *190 + '503': *195 '422': *15 x-github: githubCloudOnly: false @@ -110308,7 +109869,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &791 + - &792 name: team_id description: The unique identifier of the team. in: path @@ -110320,9 +109881,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *445 examples: - default: *438 + default: *446 '404': *6 x-github: githubCloudOnly: false @@ -110349,7 +109910,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *791 + - *792 requestBody: required: true content: @@ -110412,16 +109973,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *437 + schema: *445 examples: - default: *438 + default: *446 '201': description: Response content: application/json: - schema: *437 + schema: *445 examples: - default: *438 + default: *446 '404': *6 '422': *15 '403': *29 @@ -110449,7 +110010,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *791 + - *792 responses: '204': description: Response @@ -110480,8 +110041,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *791 - - *106 + - *792 + - *110 - *17 - *19 responses: @@ -110491,11 +110052,11 @@ paths: application/json: schema: type: array - items: *439 + items: *447 examples: - default: *792 + default: *793 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110522,7 +110083,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *791 + - *792 requestBody: required: true content: @@ -110556,9 +110117,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *447 examples: - default: *440 + default: *448 x-github: triggersNotification: true githubCloudOnly: false @@ -110585,16 +110146,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *791 - - *441 + - *792 + - *449 responses: '200': description: Response content: application/json: - schema: *439 + schema: *447 examples: - default: *440 + default: *448 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110619,8 +110180,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *791 - - *441 + - *792 + - *449 requestBody: required: false content: @@ -110643,9 +110204,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *447 examples: - default: *793 + default: *794 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110670,8 +110231,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *791 - - *441 + - *792 + - *449 responses: '204': description: Response @@ -110700,9 +110261,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *791 - - *441 - - *106 + - *792 + - *449 + - *110 - *17 - *19 responses: @@ -110712,11 +110273,11 @@ paths: application/json: schema: type: array - items: *442 + items: *450 examples: - default: *794 + default: *795 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110743,8 +110304,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *791 - - *441 + - *792 + - *449 requestBody: required: true content: @@ -110766,9 +110327,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *450 examples: - default: *443 + default: *451 x-github: triggersNotification: true githubCloudOnly: false @@ -110795,17 +110356,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *792 + - *449 + - *452 responses: '200': description: Response content: application/json: - schema: *442 + schema: *450 examples: - default: *443 + default: *451 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110830,9 +110391,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *792 + - *449 + - *452 requestBody: required: true content: @@ -110854,9 +110415,9 @@ paths: description: Response content: application/json: - schema: *442 + schema: *450 examples: - default: *795 + default: *796 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110881,9 +110442,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *792 + - *449 + - *452 responses: '204': description: Response @@ -110912,9 +110473,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *792 + - *449 + - *452 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -110940,11 +110501,11 @@ paths: application/json: schema: type: array - items: *445 + items: *453 examples: - default: *447 + default: *455 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110971,9 +110532,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *791 - - *441 - - *444 + - *792 + - *449 + - *452 requestBody: required: true content: @@ -111005,9 +110566,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111033,8 +110594,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *791 - - *441 + - *792 + - *449 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -111060,11 +110621,11 @@ paths: application/json: schema: type: array - items: *445 + items: *453 examples: - default: *447 + default: *455 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111091,8 +110652,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *791 - - *441 + - *792 + - *449 requestBody: required: true content: @@ -111124,9 +110685,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *453 examples: - default: *446 + default: *454 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -111150,7 +110711,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *791 + - *792 - *17 - *19 responses: @@ -111160,11 +110721,11 @@ paths: application/json: schema: type: array - items: *357 + items: *364 examples: - default: *358 + default: *365 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111188,7 +110749,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *791 + - *792 - name: role description: Filters members returned by their role in the team. in: query @@ -111211,9 +110772,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -111239,8 +110800,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *791 - - *138 + - *792 + - *142 responses: '204': description: if user is a member @@ -111276,8 +110837,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *791 - - *138 + - *792 + - *142 responses: '204': description: Response @@ -111316,8 +110877,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *791 - - *138 + - *792 + - *142 responses: '204': description: Response @@ -111353,16 +110914,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *791 - - *138 + - *792 + - *142 responses: '200': description: Response content: application/json: - schema: *453 + schema: *461 examples: - response-if-user-is-a-team-maintainer: *796 + response-if-user-is-a-team-maintainer: *797 '404': *6 x-github: githubCloudOnly: false @@ -111395,8 +110956,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *791 - - *138 + - *792 + - *142 requestBody: required: false content: @@ -111421,9 +110982,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *461 examples: - response-if-users-membership-with-team-is-now-pending: *797 + response-if-users-membership-with-team-is-now-pending: *798 '403': description: Forbidden if team synchronization is set up '422': @@ -111457,8 +111018,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *791 - - *138 + - *792 + - *142 responses: '204': description: Response @@ -111472,174 +111033,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/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy - parameters: - - *791 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *454 - examples: - default: *798 - headers: - Link: *43 - '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/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project-legacy - parameters: - - *791 - - *455 - responses: - '200': - description: Response - content: - application/json: - schema: *454 - examples: - default: *799 - '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/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions-legacy - parameters: - - *791 - - *455 - 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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team-legacy - parameters: - - *791 - - *455 - 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) @@ -111653,7 +111046,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *791 + - *792 - *17 - *19 responses: @@ -111663,11 +111056,11 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: *382 + default: *389 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -111695,15 +111088,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *791 - - *456 - - *457 + - *792 + - *462 + - *463 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *800 + schema: *799 examples: alternative-response-with-extra-repository-information: value: @@ -111854,9 +111247,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *791 - - *456 - - *457 + - *792 + - *462 + - *463 requestBody: required: false content: @@ -111906,9 +111299,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *791 - - *456 - - *457 + - *792 + - *462 + - *463 responses: '204': description: Response @@ -111937,15 +111330,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - - *791 + - *792 responses: '200': description: Response content: application/json: - schema: *458 + schema: *464 examples: - default: *459 + default: *465 '403': *29 '404': *6 x-github: @@ -111972,7 +111365,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - - *791 + - *792 requestBody: required: true content: @@ -112029,7 +111422,7 @@ paths: description: Response content: application/json: - schema: *458 + schema: *464 examples: default: value: @@ -112060,7 +111453,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *791 + - *792 - *17 - *19 responses: @@ -112070,11 +111463,11 @@ paths: application/json: schema: type: array - items: *303 + items: *310 examples: - response-if-child-teams-exist: *801 + response-if-child-teams-exist: *800 headers: - Link: *43 + Link: *47 '404': *6 '403': *29 '422': *15 @@ -112105,7 +111498,7 @@ paths: application/json: schema: oneOf: - - &803 + - &802 title: Private User description: Private User type: object @@ -112308,7 +111701,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *802 + - *801 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -112461,7 +111854,7 @@ paths: description: Response content: application/json: - schema: *803 + schema: *802 examples: default: value: @@ -112540,7 +111933,7 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 '304': *37 '404': *6 '403': *29 @@ -112563,7 +111956,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *138 + - *142 responses: '204': description: If the user is blocked @@ -112591,7 +111984,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - - *138 + - *142 responses: '204': description: Response @@ -112615,7 +112008,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - - *138 + - *142 responses: '204': description: Response @@ -112664,9 +112057,9 @@ paths: type: integer codespaces: type: array - items: *365 + items: *372 examples: - default: *366 + default: *373 '304': *37 '500': *40 '401': *25 @@ -112805,21 +112198,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '401': *25 '403': *29 '404': *6 - '503': *190 + '503': *195 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112859,7 +112252,7 @@ paths: type: integer secrets: type: array - items: &804 + items: &803 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -112899,9 +112292,9 @@ paths: - visibility - selected_repositories_url examples: - default: *565 + default: *567 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112969,13 +112362,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *284 + - *291 responses: '200': description: Response content: application/json: - schema: *804 + schema: *803 examples: default: value: @@ -113005,7 +112398,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *284 + - *291 requestBody: required: true content: @@ -113050,7 +112443,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -113078,7 +112471,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *284 + - *291 responses: '204': description: Response @@ -113103,7 +112496,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *284 + - *291 responses: '200': description: Response @@ -113119,9 +112512,9 @@ paths: type: integer repositories: type: array - items: *274 + items: *281 examples: - default: *805 + default: *804 '401': *25 '403': *29 '404': *6 @@ -113146,7 +112539,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *284 + - *291 requestBody: required: true content: @@ -113200,7 +112593,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *284 + - *291 - name: repository_id in: path required: true @@ -113233,7 +112626,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *284 + - *291 - name: repository_id in: path required: true @@ -113265,15 +112658,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *367 + - *374 responses: '200': description: Response content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '304': *37 '500': *40 '401': *25 @@ -113299,7 +112692,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *367 + - *374 requestBody: required: false content: @@ -113329,9 +112722,9 @@ paths: description: Response content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '401': *25 '403': *29 '404': *6 @@ -113353,7 +112746,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *367 + - *374 responses: '202': *39 '304': *37 @@ -113382,13 +112775,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *367 + - *374 responses: '202': description: Response content: application/json: - schema: &806 + schema: &805 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -113429,7 +112822,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &807 + default: &806 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -113461,7 +112854,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *367 + - *374 - name: export_id in: path required: true @@ -113474,9 +112867,9 @@ paths: description: Response content: application/json: - schema: *806 + schema: *805 examples: - default: *807 + default: *806 '404': *6 x-github: githubCloudOnly: false @@ -113497,7 +112890,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *367 + - *374 responses: '200': description: Response @@ -113513,9 +112906,9 @@ paths: type: integer machines: type: array - items: *808 + items: *807 examples: - default: *809 + default: *808 '304': *37 '500': *40 '401': *25 @@ -113544,7 +112937,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *367 + - *374 requestBody: required: true content: @@ -113599,8 +112992,8 @@ paths: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *563 - required: *564 + properties: *565 + required: *566 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -114374,15 +113767,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *367 + - *374 responses: '200': description: Response content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '304': *37 '500': *40 '400': *14 @@ -114394,7 +113787,7 @@ paths: schema: *3 '403': *29 '404': *6 - '409': *114 + '409': *118 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -114414,15 +113807,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *367 + - *374 responses: '200': description: Response content: application/json: - schema: *365 + schema: *372 examples: - default: *562 + default: *564 '500': *40 '401': *25 '403': *29 @@ -114452,9 +113845,9 @@ paths: application/json: schema: type: array - items: *376 + items: *383 examples: - default: &820 + default: &819 value: - id: 197 name: hello_docker @@ -114555,7 +113948,7 @@ paths: application/json: schema: type: array - items: &810 + items: &809 title: Email description: Email type: object @@ -114620,16 +114013,16 @@ paths: application/json: schema: type: array - items: *810 + items: *809 examples: - default: &822 + default: &821 value: - email: octocat@github.com verified: true primary: true visibility: public headers: - Link: *43 + Link: *47 '304': *37 '404': *6 '403': *29 @@ -114697,7 +114090,7 @@ paths: application/json: schema: type: array - items: *810 + items: *809 examples: default: value: @@ -114807,9 +114200,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -114840,9 +114233,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -114862,7 +114255,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *138 + - *142 responses: '204': description: if the person is followed by the authenticated user @@ -114892,7 +114285,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - - *138 + - *142 responses: '204': description: Response @@ -114917,7 +114310,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - - *138 + - *142 responses: '204': description: Response @@ -114953,7 +114346,7 @@ paths: application/json: schema: type: array - items: &811 + items: &810 title: GPG Key description: A unique encryption key type: object @@ -115084,7 +114477,7 @@ paths: - subkeys - revoked examples: - default: &836 + default: &835 value: - id: 3 name: Octocat's GPG Key @@ -115116,7 +114509,7 @@ paths: revoked: false raw_key: string headers: - Link: *43 + Link: *47 '304': *37 '404': *6 '403': *29 @@ -115169,9 +114562,9 @@ paths: description: Response content: application/json: - schema: *811 + schema: *810 examples: - default: &812 + default: &811 value: id: 3 name: Octocat's GPG Key @@ -115228,7 +114621,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &813 + - &812 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -115240,9 +114633,9 @@ paths: description: Response content: application/json: - schema: *811 + schema: *810 examples: - default: *812 + default: *811 '404': *6 '304': *37 '403': *29 @@ -115265,7 +114658,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *813 + - *812 responses: '204': description: Response @@ -115408,7 +114801,7 @@ paths: suspended_at: suspended_by: headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -115454,11 +114847,11 @@ paths: type: string repositories: type: array - items: *74 + items: *78 examples: - default: *269 + default: *276 headers: - Link: *43 + Link: *47 '404': *6 '403': *29 '304': *37 @@ -115481,7 +114874,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *268 + - *275 responses: '204': description: Response @@ -115507,7 +114900,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *268 + - *275 responses: '204': description: Response @@ -115541,12 +114934,12 @@ paths: application/json: schema: anyOf: - - *355 + - *362 - type: object properties: {} additionalProperties: false examples: - default: *356 + default: *363 '204': description: Response when there are no restrictions x-github: @@ -115570,7 +114963,7 @@ paths: required: true content: application/json: - schema: *644 + schema: *646 examples: default: value: @@ -115581,7 +114974,7 @@ paths: description: Response content: application/json: - schema: *355 + schema: *362 examples: default: value: @@ -115662,7 +115055,7 @@ paths: - closed - all default: open - - *363 + - *370 - name: sort description: What to sort results by. in: query @@ -115674,8 +115067,8 @@ paths: - updated - comments default: created - - *106 - - *217 + - *110 + - *222 - *17 - *19 responses: @@ -115685,11 +115078,11 @@ paths: application/json: schema: type: array - items: *227 + items: *232 examples: - default: *364 + default: *371 headers: - Link: *43 + Link: *47 '404': *6 '304': *37 x-github: @@ -115720,7 +115113,7 @@ paths: application/json: schema: type: array - items: &814 + items: &813 title: Key description: Key type: object @@ -115771,7 +115164,7 @@ paths: verified: false read_only: false headers: - Link: *43 + Link: *47 '304': *37 '404': *6 '403': *29 @@ -115821,9 +115214,9 @@ paths: description: Response content: application/json: - schema: *814 + schema: *813 examples: - default: &815 + default: &814 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -115856,15 +115249,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *674 + - *676 responses: '200': description: Response content: application/json: - schema: *814 + schema: *813 examples: - default: *815 + default: *814 '404': *6 '304': *37 '403': *29 @@ -115887,7 +115280,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *674 + - *676 responses: '204': description: Response @@ -115920,7 +115313,7 @@ paths: application/json: schema: type: array - items: &816 + items: &815 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -115977,7 +115370,7 @@ paths: - id - type - login - plan: *231 + plan: *236 required: - billing_cycle - next_billing_date @@ -115988,7 +115381,7 @@ paths: - account - plan examples: - default: &817 + default: &816 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -116021,7 +115414,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *43 + Link: *47 '304': *37 '401': *25 '404': *6 @@ -116050,11 +115443,11 @@ paths: application/json: schema: type: array - items: *816 + items: *815 examples: - default: *817 + default: *816 headers: - Link: *43 + Link: *47 '304': *37 '401': *25 x-github: @@ -116092,7 +115485,7 @@ paths: application/json: schema: type: array - items: *368 + items: *375 examples: default: value: @@ -116169,7 +115562,7 @@ paths: type: User site_admin: false headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -116194,13 +115587,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *368 + schema: *375 examples: default: value: @@ -116258,7 +115651,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *83 + - *87 requestBody: required: true content: @@ -116283,7 +115676,7 @@ paths: description: Response content: application/json: - schema: *368 + schema: *375 examples: default: value: @@ -116351,7 +115744,7 @@ paths: application/json: schema: type: array - items: *370 + items: *377 examples: default: value: @@ -116504,7 +115897,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -116604,7 +115997,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *377 examples: default: value: @@ -116784,7 +116177,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *371 + - *378 - name: exclude in: query required: false @@ -116797,7 +116190,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *377 examples: default: value: @@ -116991,7 +116384,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *371 + - *378 responses: '302': description: Response @@ -117017,7 +116410,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *371 + - *378 responses: '204': description: Response @@ -117046,8 +116439,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *371 - - *818 + - *378 + - *817 responses: '204': description: Response @@ -117071,7 +116464,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *371 + - *378 - *17 - *19 responses: @@ -117081,11 +116474,11 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: *382 + default: *389 headers: - Link: *43 + Link: *47 '404': *6 x-github: githubCloudOnly: false @@ -117118,11 +116511,11 @@ paths: application/json: schema: type: array - items: *69 + items: *73 examples: - default: *244 + default: *249 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -117162,7 +116555,7 @@ paths: - docker - nuget - container - - *819 + - *818 - *19 - *17 responses: @@ -117172,10 +116565,10 @@ paths: application/json: schema: type: array - items: *376 + items: *383 examples: - default: *820 - '400': *821 + default: *819 + '400': *820 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -117195,16 +116588,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *378 - - *379 + - *385 + - *386 responses: '200': description: Response content: application/json: - schema: *376 + schema: *383 examples: - default: &837 + default: &836 value: id: 40201 name: octo-name @@ -117317,8 +116710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *378 - - *379 + - *385 + - *386 responses: '204': description: Response @@ -117348,8 +116741,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *378 - - *379 + - *385 + - *386 - name: token description: package token schema: @@ -117381,8 +116774,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *378 - - *379 + - *385 + - *386 - *19 - *17 - name: state @@ -117402,7 +116795,7 @@ paths: application/json: schema: type: array - items: *380 + items: *387 examples: default: value: @@ -117451,15 +116844,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *378 - - *379 - - *381 + - *385 + - *386 + - *388 responses: '200': description: Response content: application/json: - schema: *380 + schema: *387 examples: default: value: @@ -117495,9 +116888,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *378 - - *379 - - *381 + - *385 + - *386 + - *388 responses: '204': description: Response @@ -117527,9 +116920,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *378 - - *379 - - *381 + - *385 + - *386 + - *388 responses: '204': description: Response @@ -117566,11 +116959,11 @@ paths: application/json: schema: type: array - items: *810 + items: *809 examples: - default: *822 + default: *821 headers: - Link: *43 + Link: *47 '304': *37 '404': *6 '403': *29 @@ -117679,9 +117072,9 @@ paths: application/json: schema: type: array - items: *74 + items: *78 examples: - default: &829 + default: &828 summary: Default response value: - id: 1296269 @@ -117802,7 +117195,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *43 + Link: *47 '422': *15 '304': *37 '403': *29 @@ -118025,11 +117418,11 @@ paths: application/json: schema: type: array - items: *646 + items: *648 examples: - default: *823 + default: *822 headers: - Link: *43 + Link: *47 '304': *37 '404': *6 '403': *29 @@ -118050,12 +117443,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *359 + - *366 responses: '204': description: Response '403': *29 - '409': *114 + '409': *118 '404': *6 '304': *37 x-github: @@ -118073,11 +117466,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *359 + - *366 responses: '204': description: Response - '409': *114 + '409': *118 '304': *37 '404': *6 '403': *29 @@ -118106,7 +117499,7 @@ paths: application/json: schema: type: array - items: &824 + items: &823 title: Social account description: Social media account type: object @@ -118121,12 +117514,12 @@ paths: - provider - url examples: - default: &825 + default: &824 value: - provider: twitter url: https://twitter.com/github headers: - Link: *43 + Link: *47 '304': *37 '404': *6 '403': *29 @@ -118183,9 +117576,9 @@ paths: application/json: schema: type: array - items: *824 + items: *823 examples: - default: *825 + default: *824 '422': *15 '304': *37 '404': *6 @@ -118272,7 +117665,7 @@ paths: application/json: schema: type: array - items: &826 + items: &825 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -118292,7 +117685,7 @@ paths: - title - created_at examples: - default: &841 + default: &849 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -118303,7 +117696,7 @@ paths: title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' headers: - Link: *43 + Link: *47 '304': *37 '404': *6 '403': *29 @@ -118356,9 +117749,9 @@ paths: description: Response content: application/json: - schema: *826 + schema: *825 examples: - default: &827 + default: &826 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -118388,7 +117781,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &828 + - &827 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -118400,9 +117793,9 @@ paths: description: Response content: application/json: - schema: *826 + schema: *825 examples: - default: *827 + default: *826 '404': *6 '304': *37 '403': *29 @@ -118425,7 +117818,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *828 + - *827 responses: '204': description: Response @@ -118454,7 +117847,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &842 + - &850 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 @@ -118467,7 +117860,7 @@ paths: - created - updated default: created - - *106 + - *110 - *17 - *19 responses: @@ -118477,13 +117870,13 @@ paths: application/json: schema: type: array - items: *74 + items: *78 examples: - default-response: *829 + default-response: *828 application/vnd.github.v3.star+json: schema: type: array - items: &843 + items: &851 title: Starred Repository description: Starred Repository type: object @@ -118491,7 +117884,7 @@ paths: starred_at: type: string format: date-time - repo: *74 + repo: *78 required: - starred_at - repo @@ -118619,7 +118012,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -118639,8 +118032,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response if this repository is starred by you @@ -118668,8 +118061,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -118693,8 +118086,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *456 - - *457 + - *462 + - *463 responses: '204': description: Response @@ -118727,11 +118120,11 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: *382 + default: *389 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -118766,7 +118159,7 @@ paths: application/json: schema: type: array - items: *437 + items: *445 examples: default: value: @@ -118817,7 +118210,7 @@ paths: updated_at: '2017-08-17T12:37:15Z' type: Organization headers: - Link: *43 + Link: *47 '304': *37 '404': *6 '403': *29 @@ -118844,7 +118237,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *233 + - *238 responses: '200': description: Response @@ -118852,10 +118245,10 @@ paths: application/json: schema: oneOf: - - *803 - *802 + - *801 examples: - default-response: &831 + default-response: &830 summary: Default response value: login: octocat @@ -118890,7 +118283,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &832 + response-with-git-hub-plan-information: &831 summary: Response with GitHub plan information value: login: octocat @@ -118953,7 +118346,7 @@ paths: required: true schema: type: string - - *394 + - *401 requestBody: required: true description: Details of the draft item to create in the project. @@ -118987,9 +118380,9 @@ paths: description: Response content: application/json: - schema: *400 + schema: *407 examples: - draft_issue: *401 + draft_issue: *408 '304': *37 '403': *29 '401': *25 @@ -119012,7 +118405,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *830 + - *829 - *17 responses: '200': @@ -119023,7 +118416,7 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: Link: example: ; rel="next" @@ -119053,7 +118446,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - - *138 + - *142 responses: '200': description: Response @@ -119061,11 +118454,11 @@ paths: application/json: schema: oneOf: - - *803 - *802 + - *801 examples: - default-response: *831 - response-with-git-hub-plan-information: *832 + default-response: *830 + response-with-git-hub-plan-information: *831 '404': *6 x-github: githubCloudOnly: false @@ -119089,9 +118482,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *104 - - *105 - - *138 + - *108 + - *109 + - *142 requestBody: required: true content: @@ -119115,8 +118508,8 @@ paths: required: - subject_digests examples: - default: *833 - withPredicateType: *834 + default: *832 + withPredicateType: *833 responses: '200': description: Response @@ -119169,7 +118562,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *835 + default: *834 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119187,7 +118580,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-in-bulk parameters: - - *138 + - *142 requestBody: required: true content: @@ -119252,7 +118645,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *138 + - *142 - name: subject_digest description: Subject Digest in: path @@ -119283,7 +118676,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-id parameters: - - *138 + - *142 - name: attestation_id description: Attestation ID in: path @@ -119319,9 +118712,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations parameters: - *17 - - *104 - - *105 - - *138 + - *108 + - *109 + - *142 - name: subject_digest description: Subject Digest in: path @@ -119374,12 +118767,12 @@ paths: initiator: type: string examples: - default: *507 + default: *509 '201': description: Response content: application/json: - schema: *285 + schema: *292 examples: default: value: @@ -119405,7 +118798,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *138 + - *142 responses: '200': description: Response @@ -119413,9 +118806,9 @@ paths: application/json: schema: type: array - items: *376 + items: *383 examples: - default: *820 + default: *819 '403': *29 '401': *25 x-github: @@ -119438,7 +118831,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -119448,7 +118841,7 @@ paths: application/json: schema: type: array - items: *239 + items: *244 examples: default: value: @@ -119510,8 +118903,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *138 - - *83 + - *142 + - *87 - *17 - *19 responses: @@ -119521,7 +118914,7 @@ paths: application/json: schema: type: array - items: *239 + items: *244 examples: default: value: @@ -119598,7 +118991,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -119608,7 +119001,7 @@ paths: application/json: schema: type: array - items: *239 + items: *244 examples: default: value: @@ -119666,7 +119059,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -119678,9 +119071,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119697,7 +119090,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - - *138 + - *142 - *17 - *19 responses: @@ -119709,9 +119102,9 @@ paths: type: array items: *4 examples: - default: *207 + default: *212 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119728,7 +119121,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-user-follows-another-user parameters: - - *138 + - *142 - name: target_user in: path required: true @@ -119755,8 +119148,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - - *138 - - *217 + - *142 + - *222 - *17 - *19 responses: @@ -119766,11 +119159,11 @@ paths: application/json: schema: type: array - items: *218 + items: *223 examples: - default: *219 + default: *224 headers: - Link: *43 + Link: *47 '422': *15 x-github: githubCloudOnly: false @@ -119789,7 +119182,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -119799,11 +119192,11 @@ paths: application/json: schema: type: array - items: *811 + items: *810 examples: - default: *836 + default: *835 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119825,7 +119218,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - - *138 + - *142 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -119897,7 +119290,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *138 + - *142 responses: '200': description: Response @@ -119905,7 +119298,7 @@ paths: application/json: schema: *22 examples: - default: *643 + default: *645 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -119923,7 +119316,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -119958,7 +119351,7 @@ paths: - id: 1 key: ssh-rsa AAA... headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119978,7 +119371,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -119988,11 +119381,11 @@ paths: application/json: schema: type: array - items: *69 + items: *73 examples: - default: *244 + default: *249 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -120029,8 +119422,8 @@ paths: - docker - nuget - container - - *819 - - *138 + - *818 + - *142 - *19 - *17 responses: @@ -120040,12 +119433,12 @@ paths: application/json: schema: type: array - items: *376 + items: *383 examples: - default: *820 + default: *819 '403': *29 '401': *25 - '400': *821 + '400': *820 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120065,17 +119458,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *378 - - *379 - - *138 + - *385 + - *386 + - *142 responses: '200': description: Response content: application/json: - schema: *376 + schema: *383 examples: - default: *837 + default: *836 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120096,9 +119489,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *378 - - *379 - - *138 + - *385 + - *386 + - *142 responses: '204': description: Response @@ -120130,9 +119523,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *378 - - *379 - - *138 + - *385 + - *386 + - *142 - name: token description: package token schema: @@ -120164,9 +119557,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *378 - - *379 - - *138 + - *385 + - *386 + - *142 responses: '200': description: Response @@ -120174,7 +119567,7 @@ paths: application/json: schema: type: array - items: *380 + items: *387 examples: default: value: @@ -120232,16 +119625,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-a-user parameters: - - *378 - - *379 - - *381 - - *138 + - *385 + - *386 + - *388 + - *142 responses: '200': description: Response content: application/json: - schema: *380 + schema: *387 examples: default: value: @@ -120276,10 +119669,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *378 - - *379 - - *138 - - *381 + - *385 + - *386 + - *142 + - *388 responses: '204': description: Response @@ -120311,10 +119704,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *378 - - *379 - - *138 - - *381 + - *385 + - *386 + - *142 + - *388 responses: '204': description: Response @@ -120338,15 +119731,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-projects-for-user parameters: - - *138 + - *142 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *104 - - *105 + - *108 + - *109 - *17 responses: '200': @@ -120355,11 +119748,11 @@ paths: application/json: schema: type: array - items: *392 + items: *399 examples: - default: *393 + default: *400 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -120379,18 +119772,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-user parameters: - - *394 - - *138 + - *401 + - *142 responses: '200': description: Response content: application/json: - schema: *392 + schema: *399 examples: - default: *393 + default: *400 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -120410,11 +119803,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-user parameters: - - *394 - - *138 + - *401 + - *142 - *17 - - *104 - - *105 + - *108 + - *109 responses: '200': description: Response @@ -120422,11 +119815,11 @@ paths: application/json: schema: type: array - items: *398 + items: *405 examples: - default: *838 + default: *837 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -120435,6 +119828,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/enterprise-cloud@latest//rest/projects/fields#add-field-to-user-owned-project + parameters: + - *142 + - *401 + 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: *838 + 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: *839 + 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: *840 + iteration_field: *841 + responses: + '201': + description: Response + content: + application/json: + schema: *405 + examples: + text_field: *842 + number_field: *843 + date_field: *844 + single_select_field: *845 + iteration_field: *846 + '304': *37 + '403': *29 + '401': *25 + '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 @@ -120446,19 +119949,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - - *394 - - *839 - - *138 + - *401 + - *847 + - *142 responses: '200': description: Response content: application/json: - schema: *398 + schema: *405 examples: - default: *840 + default: *848 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -120479,10 +119982,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-owned-project parameters: - - *394 - - *138 - - *104 - - *105 + - *401 + - *142 + - *108 + - *109 - *17 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) @@ -120512,11 +120015,11 @@ paths: application/json: schema: type: array - items: *402 + items: *409 examples: - default: *403 + default: *410 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -120535,8 +120038,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-user-owned-project parameters: - - *138 - - *394 + - *142 + - *401 requestBody: required: true description: Details of the item to add to the project. @@ -120573,10 +120076,10 @@ paths: description: Response content: application/json: - schema: *400 + schema: *407 examples: - issue: *401 - pull_request: *401 + issue: *408 + pull_request: *408 '304': *37 '403': *29 '401': *25 @@ -120596,9 +120099,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *394 - - *138 - - *404 + - *401 + - *142 + - *411 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -120618,11 +120121,11 @@ paths: description: Response content: application/json: - schema: *402 + schema: *409 examples: - default: *403 + default: *410 headers: - Link: *43 + Link: *47 '304': *37 '403': *29 '401': *25 @@ -120641,9 +120144,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-user parameters: - - *394 - - *138 - - *404 + - *401 + - *142 + - *411 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -120713,13 +120216,13 @@ paths: description: Response content: application/json: - schema: *402 + schema: *409 examples: - text_field: *403 - number_field: *403 - date_field: *403 - single_select_field: *403 - iteration_field: *403 + text_field: *410 + number_field: *410 + date_field: *410 + single_select_field: *410 + iteration_field: *410 '401': *25 '403': *29 '404': *6 @@ -120739,9 +120242,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-user parameters: - - *394 - - *138 - - *404 + - *401 + - *142 + - *411 responses: '204': description: Response @@ -120768,7 +120271,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -120778,7 +120281,7 @@ paths: application/json: schema: type: array - items: *239 + items: *244 examples: default: value: @@ -120843,7 +120346,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-received-by-a-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -120853,7 +120356,7 @@ paths: application/json: schema: type: array - items: *239 + items: *244 examples: default: value: @@ -120916,7 +120419,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - - *138 + - *142 - name: type description: Limit results to repositories of the specified type. in: query @@ -120959,11 +120462,11 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: *382 + default: *389 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -120981,7 +120484,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -120991,11 +120494,11 @@ paths: application/json: schema: type: array - items: *824 + items: *823 examples: - default: *825 + default: *824 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -121013,7 +120516,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -121023,11 +120526,11 @@ paths: application/json: schema: type: array - items: *826 + items: *825 examples: - default: *841 + default: *849 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -121049,9 +120552,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *138 - - *842 - - *106 + - *142 + - *850 + - *110 - *17 - *19 responses: @@ -121062,13 +120565,13 @@ paths: schema: anyOf: - type: array - items: *843 + items: *851 - type: array - items: *74 + items: *78 examples: - default-response: *829 + default-response: *828 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -121085,7 +120588,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *138 + - *142 - *17 - *19 responses: @@ -121095,11 +120598,11 @@ paths: application/json: schema: type: array - items: *274 + items: *281 examples: - default: *382 + default: *389 headers: - Link: *43 + Link: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -121225,7 +120728,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &844 + enterprise: &852 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -121283,7 +120786,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &845 + installation: &853 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -121302,7 +120805,7 @@ x-webhooks: required: - id - node_id - organization: &846 + organization: &854 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -121362,13 +120865,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &847 + repository: &855 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &884 + properties: &892 id: description: Unique identifier of the repository example: 42 @@ -121388,8 +120891,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *228 - required: *229 + properties: *233 + required: *234 nullable: true organization: title: Simple User @@ -122051,7 +121554,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &885 + required: &893 - archive_url - assignees_url - blobs_url @@ -122202,10 +121705,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -122281,11 +121784,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - rule: &848 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + rule: &856 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -122508,11 +122011,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - rule: *848 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + rule: *856 sender: *4 required: - action @@ -122695,11 +122198,11 @@ x-webhooks: - everyone required: - from - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - rule: *848 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + rule: *856 sender: *4 required: - action @@ -122772,7 +122275,7 @@ x-webhooks: required: true content: application/json: - schema: &868 + schema: &876 title: Exemption request cancellation event type: object properties: @@ -122780,11 +122283,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: &849 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + exemption_request: &857 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -123017,7 +122520,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &850 + items: &858 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -123127,7 +122630,7 @@ x-webhooks: required: true content: application/json: - schema: &869 + schema: &877 title: Exemption request completed event type: object properties: @@ -123135,11 +122638,11 @@ x-webhooks: type: string enum: - completed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + exemption_request: *857 sender: *4 required: - action @@ -123211,7 +122714,7 @@ x-webhooks: required: true content: application/json: - schema: &866 + schema: &874 title: Exemption request created event type: object properties: @@ -123219,11 +122722,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + exemption_request: *857 sender: *4 required: - action @@ -123295,7 +122798,7 @@ x-webhooks: required: true content: application/json: - schema: &870 + schema: &878 title: Exemption response dismissed event type: object properties: @@ -123303,12 +122806,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 - exemption_response: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + exemption_request: *857 + exemption_response: *858 sender: *4 required: - action @@ -123382,7 +122885,7 @@ x-webhooks: required: true content: application/json: - schema: &867 + schema: &875 title: Exemption response submitted event type: object properties: @@ -123390,12 +122893,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - exemption_request: *849 - exemption_response: *850 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + exemption_request: *857 + exemption_response: *858 sender: *4 required: - action @@ -123479,7 +122982,7 @@ x-webhooks: type: string enum: - completed - check_run: &852 + check_run: &860 title: CheckRun description: A check performed on the code of a given code change type: object @@ -123532,8 +123035,8 @@ x-webhooks: type: string pull_requests: type: array - items: *524 - repository: *274 + items: *526 + repository: *281 status: example: completed type: string @@ -123570,7 +123073,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *851 + deployment: *859 details_url: example: https://example.com type: string @@ -123620,7 +123123,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *524 + items: *526 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -123655,10 +123158,10 @@ x-webhooks: - output - app - pull_requests - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + installation: *853 + enterprise: *852 + organization: *854 + repository: *855 sender: *4 required: - check_run @@ -124051,11 +123554,11 @@ x-webhooks: type: string enum: - created - check_run: *852 - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + check_run: *860 + installation: *853 + enterprise: *852 + organization: *854 + repository: *855 sender: *4 required: - check_run @@ -124451,11 +123954,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *852 - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + check_run: *860 + installation: *853 + enterprise: *852 + organization: *854 + repository: *855 requested_action: description: The action requested by the user. type: object @@ -124860,11 +124363,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *852 - installation: *845 - enterprise: *844 - organization: *846 - repository: *847 + check_run: *860 + installation: *853 + enterprise: *852 + organization: *854 + repository: *855 sender: *4 required: - check_run @@ -125841,10 +125344,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -126117,6 +125620,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -126529,10 +126037,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -126800,6 +126308,11 @@ x-webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -127211,10 +126724,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -127380,7 +126893,7 @@ x-webhooks: required: - login - id - dismissed_comment: *537 + dismissed_comment: *539 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -127525,20 +127038,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &853 + commit_oid: &861 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: *844 - installation: *845 - organization: *846 - ref: &854 + enterprise: *852 + installation: *853 + organization: *854 + ref: &862 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: *847 + repository: *855 sender: *4 required: - action @@ -127703,7 +127216,7 @@ x-webhooks: required: - login - id - dismissed_comment: *537 + dismissed_comment: *539 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -127933,12 +127446,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *861 + enterprise: *852 + installation: *853 + organization: *854 + ref: *862 + repository: *855 sender: *4 required: - action @@ -128033,7 +127546,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *537 + dismissed_comment: *539 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -128204,12 +127717,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *861 + enterprise: *852 + installation: *853 + organization: *854 + ref: *862 + repository: *855 sender: *4 required: - action @@ -128375,7 +127888,7 @@ x-webhooks: required: - login - id - dismissed_comment: *537 + dismissed_comment: *539 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -128541,12 +128054,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *861 + enterprise: *852 + installation: *853 + organization: *854 + ref: *862 + repository: *855 sender: *4 required: - action @@ -128646,7 +128159,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *537 + dismissed_comment: *539 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -128814,16 +128327,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *847 + repository: *855 sender: *4 required: - action @@ -128920,7 +128433,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *537 + dismissed_comment: *539 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -129060,12 +128573,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *853 - enterprise: *844 - installation: *845 - organization: *846 - ref: *854 - repository: *847 + commit_oid: *861 + enterprise: *852 + installation: *853 + organization: *854 + ref: *862 + repository: *855 sender: *4 required: - action @@ -129322,10 +128835,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -129405,18 +128918,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *846 - pusher_type: &855 + organization: *854 + pusher_type: &863 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &856 + ref: &864 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -129426,7 +128939,7 @@ x-webhooks: enum: - tag - branch - repository: *847 + repository: *855 sender: *4 required: - ref @@ -129508,10 +129021,10 @@ x-webhooks: type: string enum: - created - definition: *152 - enterprise: *844 - installation: *845 - organization: *846 + definition: *156 + enterprise: *852 + installation: *853 + organization: *854 sender: *4 required: - action @@ -129596,9 +129109,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 sender: *4 required: - action @@ -129675,10 +129188,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *152 - enterprise: *844 - installation: *845 - organization: *846 + definition: *156 + enterprise: *852 + installation: *853 + organization: *854 sender: *4 required: - action @@ -129755,10 +129268,10 @@ x-webhooks: type: string enum: - updated - definition: *152 - enterprise: *844 - installation: *845 - organization: *846 + definition: *156 + enterprise: *852 + installation: *853 + organization: *854 sender: *4 required: - action @@ -129835,19 +129348,19 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - repository: *847 - organization: *846 + enterprise: *852 + installation: *853 + repository: *855 + organization: *854 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *151 + items: *155 old_property_values: type: array description: The old custom property values for the repository. - items: *151 + items: *155 required: - action - repository @@ -129923,18 +129436,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - pusher_type: *855 - ref: *856 + enterprise: *852 + installation: *853 + organization: *854 + pusher_type: *863 + ref: *864 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *847 + repository: *855 sender: *4 required: - ref @@ -130018,11 +129531,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *595 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -130106,11 +129619,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *595 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -130194,11 +129707,11 @@ x-webhooks: type: string enum: - created - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *595 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -130280,11 +129793,11 @@ x-webhooks: type: string enum: - dismissed - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *595 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -130366,11 +129879,11 @@ x-webhooks: type: string enum: - fixed - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *595 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -130453,11 +129966,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *595 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -130539,11 +130052,11 @@ x-webhooks: type: string enum: - reopened - alert: *593 - installation: *845 - organization: *846 - enterprise: *844 - repository: *847 + alert: *595 + installation: *853 + organization: *854 + enterprise: *852 + repository: *855 sender: *4 required: - action @@ -130620,9 +130133,9 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - key: &857 + enterprise: *852 + installation: *853 + key: &865 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -130658,8 +130171,8 @@ x-webhooks: - verified - created_at - read_only - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -130736,11 +130249,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - key: *857 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + key: *865 + organization: *854 + repository: *855 sender: *4 required: - action @@ -131301,12 +130814,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - workflow: &861 + workflow: &869 title: Workflow type: object nullable: true @@ -132032,13 +131545,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *599 + deployment: *601 pull_requests: type: array - items: *695 - repository: *847 - organization: *846 - installation: *845 + items: *697 + repository: *855 + organization: *854 + installation: *853 sender: *4 responses: '200': @@ -132109,7 +131622,7 @@ x-webhooks: type: string enum: - approved - approver: &858 + approver: &866 type: object properties: avatar_url: @@ -132152,11 +131665,11 @@ x-webhooks: type: string comment: type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - reviewers: &859 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + reviewers: &867 type: array items: type: object @@ -132235,7 +131748,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &860 + workflow_job_run: &868 type: object properties: conclusion: @@ -132966,18 +132479,18 @@ x-webhooks: type: string enum: - rejected - approver: *858 + approver: *866 comment: type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - reviewers: *859 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + reviewers: *867 sender: *4 since: type: string - workflow_job_run: *860 + workflow_job_run: *868 workflow_job_runs: type: array items: @@ -133681,13 +133194,13 @@ x-webhooks: type: string enum: - requested - enterprise: *844 + enterprise: *852 environment: type: string - installation: *845 - organization: *846 - repository: *847 - requestor: &871 + installation: *853 + organization: *854 + repository: *855 + requestor: &879 title: User type: object nullable: true @@ -135586,12 +135099,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - workflow: *861 + workflow: *869 workflow_run: title: Deployment Workflow Run type: object @@ -136271,7 +135784,7 @@ x-webhooks: type: string enum: - answered - answer: &864 + answer: &872 type: object properties: author_association: @@ -136428,7 +135941,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &862 + discussion: &870 title: Discussion description: A Discussion in a repository. type: object @@ -136714,7 +136227,7 @@ x-webhooks: - id labels: type: array - items: *657 + items: *659 required: - repository_url - category @@ -136736,10 +136249,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -136866,11 +136379,11 @@ x-webhooks: - from required: - category - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -136953,11 +136466,11 @@ x-webhooks: type: string enum: - closed - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -137039,7 +136552,7 @@ x-webhooks: type: string enum: - created - comment: &863 + comment: &871 type: object properties: author_association: @@ -137196,11 +136709,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -137283,12 +136796,12 @@ x-webhooks: type: string enum: - deleted - comment: *863 - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + comment: *871 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -137383,12 +136896,12 @@ x-webhooks: - from required: - body - comment: *863 - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + comment: *871 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -137472,11 +136985,11 @@ x-webhooks: type: string enum: - created - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -137558,11 +137071,11 @@ x-webhooks: type: string enum: - deleted - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -137662,11 +137175,11 @@ x-webhooks: type: string required: - from - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -137748,10 +137261,10 @@ x-webhooks: type: string enum: - labeled - discussion: *862 - enterprise: *844 - installation: *845 - label: &865 + discussion: *870 + enterprise: *852 + installation: *853 + label: &873 title: Label type: object properties: @@ -137783,8 +137296,8 @@ x-webhooks: - color - default - description - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -137867,11 +137380,11 @@ x-webhooks: type: string enum: - locked - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -137953,11 +137466,11 @@ x-webhooks: type: string enum: - pinned - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -138039,11 +137552,11 @@ x-webhooks: type: string enum: - reopened - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -138128,16 +137641,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *862 - new_repository: *847 + new_discussion: *870 + new_repository: *855 required: - new_discussion - new_repository - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -138220,10 +137733,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *862 - old_answer: *864 - organization: *846 - repository: *847 + discussion: *870 + old_answer: *872 + organization: *854 + repository: *855 sender: *4 required: - action @@ -138305,12 +137818,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *862 - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -138393,11 +137906,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -138479,11 +137992,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *862 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + discussion: *870 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -138552,7 +138065,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *874 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138615,7 +138128,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138681,7 +138194,7 @@ x-webhooks: required: true content: application/json: - schema: *868 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138747,7 +138260,7 @@ x-webhooks: required: true content: application/json: - schema: *869 + schema: *877 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138813,7 +138326,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *874 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138879,7 +138392,7 @@ x-webhooks: required: true content: application/json: - schema: *870 + schema: *878 responses: '200': description: Return a 200 status to indicate that the data was received @@ -138945,7 +138458,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139010,7 +138523,7 @@ x-webhooks: required: true content: application/json: - schema: *868 + schema: *876 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139075,7 +138588,7 @@ x-webhooks: required: true content: application/json: - schema: *869 + schema: *877 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139140,7 +138653,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *874 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139205,7 +138718,7 @@ x-webhooks: required: true content: application/json: - schema: *870 + schema: *878 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139271,7 +138784,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *875 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139338,7 +138851,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *844 + enterprise: *852 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -139998,9 +139511,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *845 - organization: *846 - repository: *847 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - forkee @@ -140146,9 +139659,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 pages: description: The pages that were updated. type: array @@ -140185,7 +139698,7 @@ x-webhooks: - action - sha - html_url - repository: *847 + repository: *855 sender: *4 required: - pages @@ -140261,10 +139774,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 + enterprise: *852 installation: *22 - organization: *846 - repositories: &872 + organization: *854 + repositories: &880 description: An array of repository objects that the installation can access. type: array @@ -140290,8 +139803,8 @@ x-webhooks: - name - full_name - private - repository: *847 - requester: *871 + repository: *855 + requester: *879 sender: *4 required: - action @@ -140366,11 +139879,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 + enterprise: *852 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *854 + repositories: *880 + repository: *855 requester: nullable: true sender: *4 @@ -140446,11 +139959,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *844 + enterprise: *852 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *854 + repositories: *880 + repository: *855 requester: nullable: true sender: *4 @@ -140526,10 +140039,10 @@ x-webhooks: type: string enum: - added - enterprise: *844 + enterprise: *852 installation: *22 - organization: *846 - repositories_added: &873 + organization: *854 + repositories_added: &881 description: An array of repository objects, which were added to the installation. type: array @@ -140575,15 +140088,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *847 - repository_selection: &874 + repository: *855 + repository_selection: &882 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *871 + requester: *879 sender: *4 required: - action @@ -140662,10 +140175,10 @@ x-webhooks: type: string enum: - removed - enterprise: *844 + enterprise: *852 installation: *22 - organization: *846 - repositories_added: *873 + organization: *854 + repositories_added: *881 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -140692,9 +140205,9 @@ x-webhooks: - name - full_name - private - repository: *847 - repository_selection: *874 - requester: *871 + repository: *855 + repository_selection: *882 + requester: *879 sender: *4 required: - action @@ -140773,11 +140286,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *844 + enterprise: *852 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *854 + repositories: *880 + repository: *855 requester: nullable: true sender: *4 @@ -140956,10 +140469,10 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 target_type: type: string @@ -141038,11 +140551,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *844 + enterprise: *852 installation: *22 - organization: *846 - repositories: *872 - repository: *847 + organization: *854 + repositories: *880 + repository: *855 requester: nullable: true sender: *4 @@ -141166,8 +140679,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *212 - required: *213 + properties: *217 + required: *218 reactions: title: Reactions type: object @@ -141294,8 +140807,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -142089,8 +141602,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142106,7 +141619,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -142439,8 +141952,8 @@ x-webhooks: - state - locked - assignee - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -142520,7 +142033,7 @@ x-webhooks: type: string enum: - deleted - comment: &875 + comment: &883 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -142685,8 +142198,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -143476,8 +142989,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143493,7 +143006,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -143828,8 +143341,8 @@ x-webhooks: - state - locked - assignee - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -143909,7 +143422,7 @@ x-webhooks: type: string enum: - edited - changes: &904 + changes: &912 description: The changes to the comment. type: object properties: @@ -143921,9 +143434,9 @@ x-webhooks: type: string required: - from - comment: *875 - enterprise: *844 - installation: *845 + comment: *883 + enterprise: *852 + installation: *853 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -144716,8 +144229,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144733,7 +144246,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -145066,8 +144579,8 @@ x-webhooks: - state - locked - assignee - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145151,15 +144664,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *227 + blocked_issue: *232 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *227 - blocking_issue_repo: *74 - installation: *845 - organization: *846 - repository: *847 + blocking_issue: *232 + blocking_issue_repo: *78 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145247,15 +144760,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *227 + blocked_issue: *232 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *227 - blocking_issue_repo: *74 - installation: *845 - organization: *846 - repository: *847 + blocking_issue: *232 + blocking_issue_repo: *78 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145342,15 +144855,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *227 - blocked_issue_repo: *74 + blocked_issue: *232 + blocked_issue_repo: *78 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *227 - installation: *845 - organization: *846 - repository: *847 + blocking_issue: *232 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145438,15 +144951,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *227 - blocked_issue_repo: *74 + blocked_issue: *232 + blocked_issue_repo: *78 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *227 - installation: *845 - organization: *846 - repository: *847 + blocking_issue: *232 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -145531,10 +145044,10 @@ x-webhooks: type: string enum: - assigned - assignee: *871 - enterprise: *844 - installation: *845 - issue: &878 + assignee: *879 + enterprise: *852 + installation: *853 + issue: &886 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -146323,11 +145836,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146343,7 +145856,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -146444,8 +145957,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -146525,8 +146038,8 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -147320,11 +146833,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147340,7 +146853,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -147576,8 +147089,8 @@ x-webhooks: required: - state - closed_at - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -147656,8 +147169,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -148442,11 +147955,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148462,7 +147975,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -148562,8 +148075,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -148642,8 +148155,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -149450,11 +148963,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149470,7 +148983,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -149549,7 +149062,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &876 + milestone: &884 title: Milestone description: A collection of related issues and pull requests. type: object @@ -149687,8 +149200,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -149787,8 +149300,8 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -150577,11 +150090,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150594,7 +150107,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *360 + type: *367 title: description: Title of the issue type: string @@ -150698,9 +150211,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *865 - organization: *846 - repository: *847 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -150780,8 +150293,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -151569,11 +151082,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151586,7 +151099,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *360 + type: *367 title: description: Title of the issue type: string @@ -151690,9 +151203,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *865 - organization: *846 - repository: *847 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -151772,8 +151285,8 @@ x-webhooks: type: string enum: - locked - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -152585,11 +152098,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152602,7 +152115,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *360 + type: *367 title: description: Title of the issue type: string @@ -152683,8 +152196,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -152763,8 +152276,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -153570,11 +153083,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153590,7 +153103,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -153668,9 +153181,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *876 - organization: *846 - repository: *847 + milestone: *884 + organization: *854 + repository: *855 sender: *4 required: - action @@ -154538,11 +154051,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154635,7 +154148,7 @@ x-webhooks: required: - login - id - type: *360 + type: *367 required: - id - number @@ -155104,8 +154617,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -155894,11 +155407,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155914,7 +155427,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -156014,8 +155527,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -156095,9 +155608,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *844 - installation: *845 - issue: &877 + enterprise: *852 + installation: *853 + issue: &885 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -156880,11 +156393,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156900,7 +156413,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -157000,8 +156513,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -157080,8 +156593,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -157891,11 +157404,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157989,9 +157502,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *360 - organization: *846 - repository: *847 + type: *367 + organization: *854 + repository: *855 sender: *4 required: - action @@ -158857,11 +158370,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -158877,7 +158390,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -159445,11 +158958,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *844 - installation: *845 - issue: *877 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + issue: *885 + organization: *854 + repository: *855 sender: *4 required: - action @@ -159529,12 +159042,12 @@ x-webhooks: type: string enum: - typed - enterprise: *844 - installation: *845 - issue: *878 - type: *360 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + issue: *886 + type: *367 + organization: *854 + repository: *855 sender: *4 required: - action @@ -159615,7 +159128,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &907 + assignee: &915 title: User type: object nullable: true @@ -159685,11 +159198,11 @@ x-webhooks: required: - login - id - enterprise: *844 - installation: *845 - issue: *878 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + issue: *886 + organization: *854 + repository: *855 sender: *4 required: - action @@ -159768,12 +159281,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *844 - installation: *845 - issue: *878 - label: *865 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + issue: *886 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -159853,8 +159366,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -160664,11 +160177,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *788 - issue_dependencies_summary: *789 + sub_issues_summary: *789 + issue_dependencies_summary: *790 issue_field_values: type: array - items: *790 + items: *791 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160684,7 +160197,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *360 + type: *367 updated_at: type: string format: date-time @@ -160762,8 +160275,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -160843,11 +160356,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *844 - installation: *845 - issue: *877 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + issue: *885 + organization: *854 + repository: *855 sender: *4 required: - action @@ -160926,12 +160439,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *844 - installation: *845 - issue: *878 - type: *360 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + issue: *886 + type: *367 + organization: *854 + repository: *855 sender: *4 required: - action @@ -161011,11 +160524,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -161093,11 +160606,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -161207,11 +160720,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - label: *865 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + label: *873 + organization: *854 + repository: *855 sender: *4 required: - action @@ -161293,9 +160806,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: &879 + enterprise: *852 + installation: *853 + marketplace_purchase: &887 title: Marketplace Purchase type: object required: @@ -161378,8 +160891,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *846 - previous_marketplace_purchase: &880 + organization: *854 + previous_marketplace_purchase: &888 title: Marketplace Purchase type: object properties: @@ -161459,7 +160972,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *847 + repository: *855 sender: *4 required: - action @@ -161539,10 +161052,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: *879 - organization: *846 + enterprise: *852 + installation: *853 + marketplace_purchase: *887 + organization: *854 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -161625,7 +161138,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *847 + repository: *855 sender: *4 required: - action @@ -161707,10 +161220,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: *879 - organization: *846 + enterprise: *852 + installation: *853 + marketplace_purchase: *887 + organization: *854 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -161792,7 +161305,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *847 + repository: *855 sender: *4 required: - action @@ -161873,8 +161386,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 marketplace_purchase: title: Marketplace Purchase type: object @@ -161956,9 +161469,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *846 - previous_marketplace_purchase: *880 - repository: *847 + organization: *854 + previous_marketplace_purchase: *888 + repository: *855 sender: *4 required: - action @@ -162038,12 +161551,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *844 - installation: *845 - marketplace_purchase: *879 - organization: *846 - previous_marketplace_purchase: *880 - repository: *847 + enterprise: *852 + installation: *853 + marketplace_purchase: *887 + organization: *854 + previous_marketplace_purchase: *888 + repository: *855 sender: *4 required: - action @@ -162145,11 +161658,11 @@ x-webhooks: type: string required: - to - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + member: *879 + organization: *854 + repository: *855 sender: *4 required: - action @@ -162249,11 +161762,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + member: *879 + organization: *854 + repository: *855 sender: *4 required: - action @@ -162332,11 +161845,11 @@ x-webhooks: type: string enum: - removed - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + member: *879 + organization: *854 + repository: *855 sender: *4 required: - action @@ -162414,11 +161927,11 @@ x-webhooks: type: string enum: - added - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + member: *879 + organization: *854 + repository: *855 scope: description: The scope of the membership. Currently, can only be `team`. @@ -162494,7 +162007,7 @@ x-webhooks: required: - login - id - team: &881 + team: &889 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -162717,11 +162230,11 @@ x-webhooks: type: string enum: - removed - enterprise: *844 - installation: *845 - member: *871 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + member: *879 + organization: *854 + repository: *855 scope: description: The scope of the membership. Currently, can only be `team`. @@ -162798,7 +162311,7 @@ x-webhooks: required: - login - id - team: *881 + team: *889 required: - action - scope @@ -162880,8 +162393,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *845 - merge_group: &883 + installation: *853 + merge_group: &891 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -162900,15 +162413,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *882 + head_commit: *890 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -162994,10 +162507,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *845 - merge_group: *883 - organization: *846 - repository: *847 + installation: *853 + merge_group: *891 + organization: *854 + repository: *855 sender: *4 required: - action @@ -163070,7 +162583,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 + enterprise: *852 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -163179,16 +162692,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *845 - organization: *846 + installation: *853 + organization: *854 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *892 + required: *893 nullable: true sender: *4 required: @@ -163269,11 +162782,11 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 - milestone: *876 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + milestone: *884 + organization: *854 + repository: *855 sender: *4 required: - action @@ -163352,9 +162865,9 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - milestone: &886 + enterprise: *852 + installation: *853 + milestone: &894 title: Milestone description: A collection of related issues and pull requests. type: object @@ -163491,8 +163004,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -163571,11 +163084,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - milestone: *876 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + milestone: *884 + organization: *854 + repository: *855 sender: *4 required: - action @@ -163685,11 +163198,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - milestone: *876 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + milestone: *884 + organization: *854 + repository: *855 sender: *4 required: - action @@ -163769,11 +163282,11 @@ x-webhooks: type: string enum: - opened - enterprise: *844 - installation: *845 - milestone: *886 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + milestone: *894 + organization: *854 + repository: *855 sender: *4 required: - action @@ -163852,11 +163365,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *871 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + blocked_user: *879 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -163935,11 +163448,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *871 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + blocked_user: *879 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -164014,8 +163527,8 @@ x-webhooks: type: string enum: - created - definition: *146 - enterprise: *844 + definition: *150 + enterprise: *852 sender: *4 required: - action @@ -164095,8 +163608,8 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 sender: *4 required: - action @@ -164168,9 +163681,9 @@ x-webhooks: type: string enum: - updated - definition: *146 - enterprise: *844 - installation: *845 + definition: *150 + enterprise: *852 + installation: *853 sender: *4 required: - action @@ -164242,18 +163755,18 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 sender: *4 new_property_values: type: array description: The new custom property values. - items: *151 + items: *155 old_property_values: type: array description: The old custom property values. - items: *151 + items: *155 required: - action - organization @@ -164332,9 +163845,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - membership: &887 + enterprise: *852 + installation: *853 + membership: &895 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -164441,8 +163954,8 @@ x-webhooks: - role - organization_url - user - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 required: - action @@ -164520,11 +164033,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *844 - installation: *845 - membership: *887 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + membership: *895 + organization: *854 + repository: *855 sender: *4 required: - action @@ -164603,8 +164116,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -164720,10 +164233,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 - user: *871 + user: *879 required: - action - invitation @@ -164801,11 +164314,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *844 - installation: *845 - membership: *887 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + membership: *895 + organization: *854 + repository: *855 sender: *4 required: - action @@ -164892,11 +164405,11 @@ x-webhooks: properties: from: type: string - enterprise: *844 - installation: *845 - membership: *887 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + membership: *895 + organization: *854 + repository: *855 sender: *4 required: - action @@ -164972,9 +164485,9 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 package: description: Information about the package. type: object @@ -165473,7 +164986,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &888 + items: &896 title: Ruby Gems metadata type: object properties: @@ -165568,7 +165081,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *855 sender: *4 required: - action @@ -165644,9 +165157,9 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 package: description: Information about the package. type: object @@ -165999,7 +165512,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *888 + items: *896 source_url: type: string format: uri @@ -166069,7 +165582,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *855 sender: *4 required: - action @@ -166246,12 +165759,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *844 + enterprise: *852 id: type: integer - installation: *845 - organization: *846 - repository: *847 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - id @@ -166328,7 +165841,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &889 + personal_access_token_request: &897 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -166474,10 +165987,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *844 - organization: *846 + enterprise: *852 + organization: *854 sender: *4 - installation: *845 + installation: *853 required: - action - personal_access_token_request @@ -166554,11 +166067,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *889 - enterprise: *844 - organization: *846 + personal_access_token_request: *897 + enterprise: *852 + organization: *854 sender: *4 - installation: *845 + installation: *853 required: - action - personal_access_token_request @@ -166634,11 +166147,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *889 - enterprise: *844 - organization: *846 + personal_access_token_request: *897 + enterprise: *852 + organization: *854 sender: *4 - installation: *845 + installation: *853 required: - action - personal_access_token_request @@ -166713,11 +166226,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *889 - organization: *846 - enterprise: *844 + personal_access_token_request: *897 + organization: *854 + enterprise: *852 sender: *4 - installation: *845 + installation: *853 required: - action - personal_access_token_request @@ -166822,7 +166335,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *890 + last_response: *898 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -166854,8 +166367,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 zen: description: Random string of GitHub zen. @@ -167100,10 +166613,10 @@ x-webhooks: - from required: - note - enterprise: *844 - installation: *845 - organization: *846 - project_card: &891 + enterprise: *852 + installation: *853 + organization: *854 + project_card: &899 title: Project Card type: object properties: @@ -167222,7 +166735,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *847 + repository: *855 sender: *4 required: - action @@ -167303,11 +166816,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - project_card: *891 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + project_card: *899 + repository: *855 sender: *4 required: - action @@ -167387,9 +166900,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 project_card: title: Project Card type: object @@ -167517,8 +167030,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *892 + required: *893 nullable: true sender: *4 required: @@ -167612,11 +167125,11 @@ x-webhooks: - from required: - note - enterprise: *844 - installation: *845 - organization: *846 - project_card: *891 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + project_card: *899 + repository: *855 sender: *4 required: - action @@ -167710,9 +167223,9 @@ x-webhooks: - from required: - column_id - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 project_card: allOf: - title: Project Card @@ -167902,7 +167415,7 @@ x-webhooks: type: string required: - after_id - repository: *847 + repository: *855 sender: *4 required: - action @@ -167982,10 +167495,10 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 - organization: *846 - project: &893 + enterprise: *852 + installation: *853 + organization: *854 + project: &901 title: Project type: object properties: @@ -168109,7 +167622,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *847 + repository: *855 sender: *4 required: - action @@ -168189,10 +167702,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - project_column: &892 + enterprise: *852 + installation: *853 + organization: *854 + project_column: &900 title: Project Column type: object properties: @@ -168231,7 +167744,7 @@ x-webhooks: - name - created_at - updated_at - repository: *847 + repository: *855 sender: *4 required: - action @@ -168310,18 +167823,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - project_column: *892 + enterprise: *852 + installation: *853 + organization: *854 + project_column: *900 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *892 + required: *893 nullable: true sender: *4 required: @@ -168411,11 +167924,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - project_column: *892 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + project_column: *900 + repository: *855 sender: *4 required: - action @@ -168495,11 +168008,11 @@ x-webhooks: type: string enum: - moved - enterprise: *844 - installation: *845 - organization: *846 - project_column: *892 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + project_column: *900 + repository: *855 sender: *4 required: - action @@ -168579,11 +168092,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - project: *893 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + project: *901 + repository: *855 sender: *4 required: - action @@ -168663,18 +168176,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - project: *893 + enterprise: *852 + installation: *853 + organization: *854 + project: *901 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *884 - required: *885 + properties: *892 + required: *893 nullable: true sender: *4 required: @@ -168776,11 +168289,11 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - project: *893 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + project: *901 + repository: *855 sender: *4 required: - action @@ -168859,11 +168372,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *844 - installation: *845 - organization: *846 - project: *893 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + project: *901 + repository: *855 sender: *4 required: - action @@ -168944,9 +168457,9 @@ x-webhooks: type: string enum: - closed - installation: *845 - organization: *846 - projects_v2: *392 + installation: *853 + organization: *854 + projects_v2: *399 sender: *4 required: - action @@ -169027,9 +168540,9 @@ x-webhooks: type: string enum: - created - installation: *845 - organization: *846 - projects_v2: *392 + installation: *853 + organization: *854 + projects_v2: *399 sender: *4 required: - action @@ -169110,9 +168623,9 @@ x-webhooks: type: string enum: - deleted - installation: *845 - organization: *846 - projects_v2: *392 + installation: *853 + organization: *854 + projects_v2: *399 sender: *4 required: - action @@ -169229,9 +168742,9 @@ x-webhooks: type: string to: type: string - installation: *845 - organization: *846 - projects_v2: *392 + installation: *853 + organization: *854 + projects_v2: *399 sender: *4 required: - action @@ -169314,7 +168827,7 @@ x-webhooks: type: string enum: - archived - changes: &897 + changes: &905 type: object properties: archived_at: @@ -169328,9 +168841,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *845 - organization: *846 - projects_v2_item: &894 + installation: *853 + organization: *854 + projects_v2_item: &902 title: Projects v2 Item description: An item belonging to a project type: object @@ -169348,7 +168861,7 @@ x-webhooks: type: string description: The node ID of the content represented by this item. - content_type: *399 + content_type: *406 creator: *4 created_at: type: string @@ -169465,9 +168978,9 @@ x-webhooks: nullable: true to: type: string - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *853 + organization: *854 + projects_v2_item: *902 sender: *4 required: - action @@ -169549,9 +169062,9 @@ x-webhooks: type: string enum: - created - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *853 + organization: *854 + projects_v2_item: *902 sender: *4 required: - action @@ -169632,9 +169145,9 @@ x-webhooks: type: string enum: - deleted - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *853 + organization: *854 + projects_v2_item: *902 sender: *4 required: - action @@ -169740,7 +169253,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &895 + - &903 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -169762,7 +169275,7 @@ x-webhooks: required: - id - name - - &896 + - &904 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -169796,8 +169309,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *895 - - *896 + - *903 + - *904 required: - field_value - type: object @@ -169813,9 +169326,9 @@ x-webhooks: nullable: true required: - body - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *853 + organization: *854 + projects_v2_item: *902 sender: *4 required: - action @@ -169910,9 +169423,9 @@ x-webhooks: to: type: string nullable: true - installation: *845 - organization: *846 - projects_v2_item: *894 + installation: *853 + organization: *854 + projects_v2_item: *902 sender: *4 required: - action @@ -169995,10 +169508,10 @@ x-webhooks: type: string enum: - restored - changes: *897 - installation: *845 - organization: *846 - projects_v2_item: *894 + changes: *905 + installation: *853 + organization: *854 + projects_v2_item: *902 sender: *4 required: - action @@ -170080,9 +169593,9 @@ x-webhooks: type: string enum: - reopened - installation: *845 - organization: *846 - projects_v2: *392 + installation: *853 + organization: *854 + projects_v2: *399 sender: *4 required: - action @@ -170163,14 +169676,14 @@ x-webhooks: type: string enum: - created - installation: *845 - organization: *846 - projects_v2_status_update: &900 + installation: *853 + organization: *854 + projects_v2_status_update: &908 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *898 - required: *899 + properties: *906 + required: *907 sender: *4 required: - action @@ -170251,9 +169764,9 @@ x-webhooks: type: string enum: - deleted - installation: *845 - organization: *846 - projects_v2_status_update: *900 + installation: *853 + organization: *854 + projects_v2_status_update: *908 sender: *4 required: - action @@ -170389,9 +169902,9 @@ x-webhooks: type: string format: date nullable: true - installation: *845 - organization: *846 - projects_v2_status_update: *900 + installation: *853 + organization: *854 + projects_v2_status_update: *908 sender: *4 required: - action @@ -170462,10 +169975,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - repository @@ -170542,13 +170055,13 @@ x-webhooks: type: string enum: - assigned - assignee: *871 - enterprise: *844 - installation: *845 - number: &901 + assignee: *879 + enterprise: *852 + installation: *853 + number: &909 description: The pull request number. type: integer - organization: *846 + organization: *854 pull_request: title: Pull Request type: object @@ -172831,7 +172344,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 sender: *4 required: - action @@ -172913,11 +172426,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 number: type: integer - organization: *846 + organization: *854 pull_request: title: Pull Request type: object @@ -175195,7 +174708,7 @@ x-webhooks: - draft reason: type: string - repository: *847 + repository: *855 sender: *4 required: - action @@ -175277,11 +174790,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 number: type: integer - organization: *846 + organization: *854 pull_request: title: Pull Request type: object @@ -177559,7 +177072,7 @@ x-webhooks: - draft reason: type: string - repository: *847 + repository: *855 sender: *4 required: - action @@ -177641,13 +177154,13 @@ x-webhooks: type: string enum: - closed - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: &902 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 + pull_request: &910 allOf: - - *695 + - *697 - type: object properties: allow_auto_merge: @@ -177709,7 +177222,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *847 + repository: *855 sender: *4 required: - action @@ -177790,12 +177303,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 + pull_request: *910 + repository: *855 sender: *4 required: - action @@ -177875,11 +177388,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *844 - milestone: *677 - number: *901 - organization: *846 - pull_request: &903 + enterprise: *852 + milestone: *679 + number: *909 + organization: *854 + pull_request: &911 title: Pull Request type: object properties: @@ -180142,7 +179655,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 sender: *4 required: - action @@ -180221,11 +179734,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 number: type: integer - organization: *846 + organization: *854 pull_request: title: Pull Request type: object @@ -182507,7 +182020,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *847 + repository: *855 sender: *4 required: - action @@ -182631,12 +182144,12 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 + pull_request: *910 + repository: *855 sender: *4 required: - action @@ -182716,11 +182229,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 number: type: integer - organization: *846 + organization: *854 pull_request: title: Pull Request type: object @@ -184987,7 +184500,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 sender: *4 required: - action @@ -185067,11 +184580,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *844 - installation: *845 - label: *865 - number: *901 - organization: *846 + enterprise: *852 + installation: *853 + label: *873 + number: *909 + organization: *854 pull_request: title: Pull Request type: object @@ -187353,7 +186866,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 sender: *4 required: - action @@ -187434,10 +186947,10 @@ x-webhooks: type: string enum: - locked - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 pull_request: title: Pull Request type: object @@ -189717,7 +189230,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 sender: *4 required: - action @@ -189797,12 +189310,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *844 - milestone: *677 - number: *901 - organization: *846 - pull_request: *903 - repository: *847 + enterprise: *852 + milestone: *679 + number: *909 + organization: *854 + pull_request: *911 + repository: *855 sender: *4 required: - action @@ -189881,12 +189394,12 @@ x-webhooks: type: string enum: - opened - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 + pull_request: *910 + repository: *855 sender: *4 required: - action @@ -189967,12 +189480,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 + pull_request: *910 + repository: *855 sender: *4 required: - action @@ -190052,12 +189565,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *844 - installation: *845 - number: *901 - organization: *846 - pull_request: *902 - repository: *847 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 + pull_request: *910 + repository: *855 sender: *4 required: - action @@ -190423,9 +189936,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 pull_request: type: object properties: @@ -192595,7 +192108,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *847 + repository: *855 sender: *4 required: - action @@ -192675,7 +192188,7 @@ x-webhooks: type: string enum: - deleted - comment: &905 + comment: &913 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -192960,9 +192473,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 pull_request: type: object properties: @@ -195120,7 +194633,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *847 + repository: *855 sender: *4 required: - action @@ -195200,11 +194713,11 @@ x-webhooks: type: string enum: - edited - changes: *904 - comment: *905 - enterprise: *844 - installation: *845 - organization: *846 + changes: *912 + comment: *913 + enterprise: *852 + installation: *853 + organization: *854 pull_request: type: object properties: @@ -197365,7 +196878,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *847 + repository: *855 sender: *4 required: - action @@ -197446,9 +196959,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 pull_request: title: Simple Pull Request type: object @@ -199621,7 +199134,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 + repository: *855 review: description: The review that was affected. type: object @@ -199868,9 +199381,9 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 pull_request: title: Simple Pull Request type: object @@ -201924,8 +201437,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 - review: &906 + repository: *855 + review: &914 description: The review that was affected. type: object properties: @@ -202158,12 +201671,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 number: description: The pull request number. type: integer - organization: *846 + organization: *854 pull_request: title: Pull Request type: object @@ -204446,7 +203959,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 requested_reviewer: title: User type: object @@ -204530,12 +204043,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 number: description: The pull request number. type: integer - organization: *846 + organization: *854 pull_request: title: Pull Request type: object @@ -206825,7 +206338,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 requested_team: title: Team description: Groups of organization members that gives permissions @@ -207017,12 +206530,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 number: description: The pull request number. type: integer - organization: *846 + organization: *854 pull_request: title: Pull Request type: object @@ -209307,7 +208820,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 requested_reviewer: title: User type: object @@ -209392,12 +208905,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *844 - installation: *845 + enterprise: *852 + installation: *853 number: description: The pull request number. type: integer - organization: *846 + organization: *854 pull_request: title: Pull Request type: object @@ -211673,7 +211186,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 requested_team: title: Team description: Groups of organization members that gives permissions @@ -211854,9 +211367,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 pull_request: title: Simple Pull Request type: object @@ -214031,8 +213544,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 - review: *906 + repository: *855 + review: *914 sender: *4 required: - action @@ -214112,9 +213625,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 pull_request: title: Simple Pull Request type: object @@ -216184,7 +215697,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 + repository: *855 sender: *4 thread: type: object @@ -216571,9 +216084,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 pull_request: title: Simple Pull Request type: object @@ -218629,7 +218142,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *847 + repository: *855 sender: *4 thread: type: object @@ -219019,10 +218532,10 @@ x-webhooks: type: string before: type: string - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 pull_request: title: Pull Request type: object @@ -221293,7 +220806,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 sender: *4 required: - action @@ -221375,11 +220888,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *907 - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + assignee: *915 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 pull_request: title: Pull Request type: object @@ -223662,7 +223175,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 sender: *4 required: - action @@ -223741,11 +223254,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *844 - installation: *845 - label: *865 - number: *901 - organization: *846 + enterprise: *852 + installation: *853 + label: *873 + number: *909 + organization: *854 pull_request: title: Pull Request type: object @@ -226018,7 +225531,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 sender: *4 required: - action @@ -226099,10 +225612,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *844 - installation: *845 - number: *901 - organization: *846 + enterprise: *852 + installation: *853 + number: *909 + organization: *854 pull_request: title: Pull Request type: object @@ -228367,7 +227880,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *847 + repository: *855 sender: *4 required: - action @@ -228567,7 +228080,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *844 + enterprise: *852 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -228659,8 +228172,8 @@ x-webhooks: - url - author - committer - installation: *845 - organization: *846 + installation: *853 + organization: *854 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -229235,9 +228748,9 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 registry_package: type: object properties: @@ -229683,7 +229196,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *888 + items: *896 summary: type: string tag_name: @@ -229737,7 +229250,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *855 sender: *4 required: - action @@ -229815,9 +229328,9 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 registry_package: type: object properties: @@ -230125,7 +229638,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *888 + items: *896 summary: type: string tag_name: @@ -230174,7 +229687,7 @@ x-webhooks: - owner - package_version - registry - repository: *847 + repository: *855 sender: *4 required: - action @@ -230251,10 +229764,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - release: &908 + enterprise: *852 + installation: *853 + organization: *854 + release: &916 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -230572,7 +230085,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *847 + repository: *855 sender: *4 required: - action @@ -230649,11 +230162,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - release: *908 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + release: *916 + repository: *855 sender: *4 required: - action @@ -230770,11 +230283,11 @@ x-webhooks: type: boolean required: - to - enterprise: *844 - installation: *845 - organization: *846 - release: *908 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + release: *916 + repository: *855 sender: *4 required: - action @@ -230852,9 +230365,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -231176,7 +230689,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *847 + repository: *855 sender: *4 required: - action @@ -231252,10 +230765,10 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 - release: &909 + enterprise: *852 + installation: *853 + organization: *854 + release: &917 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -231574,7 +231087,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *847 + repository: *855 sender: *4 required: - action @@ -231650,11 +231163,11 @@ x-webhooks: type: string enum: - released - enterprise: *844 - installation: *845 - organization: *846 - release: *908 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + release: *916 + repository: *855 sender: *4 required: - action @@ -231730,11 +231243,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *844 - installation: *845 - organization: *846 - release: *909 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + release: *917 + repository: *855 sender: *4 required: - action @@ -231810,11 +231323,11 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - repository_advisory: *748 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + repository_advisory: *749 sender: *4 required: - action @@ -231890,11 +231403,11 @@ x-webhooks: type: string enum: - reported - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - repository_advisory: *748 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + repository_advisory: *749 sender: *4 required: - action @@ -231970,10 +231483,10 @@ x-webhooks: type: string enum: - archived - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -232050,10 +231563,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -232131,10 +231644,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -232218,10 +231731,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -232333,10 +231846,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -232408,10 +231921,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 status: type: string @@ -232492,10 +232005,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -232572,10 +232085,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -232669,10 +232182,10 @@ x-webhooks: - name required: - repository - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -232752,11 +232265,11 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - repository_ruleset: *185 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + repository_ruleset: *190 sender: *4 required: - action @@ -232834,11 +232347,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - repository_ruleset: *185 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + repository_ruleset: *190 sender: *4 required: - action @@ -232916,11 +232429,11 @@ x-webhooks: type: string enum: - edited - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - repository_ruleset: *185 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + repository_ruleset: *190 changes: type: object properties: @@ -232939,16 +232452,16 @@ x-webhooks: properties: added: type: array - items: *157 + items: *161 deleted: type: array - items: *157 + items: *161 updated: type: array items: type: object properties: - condition: *157 + condition: *161 changes: type: object properties: @@ -232981,16 +232494,16 @@ x-webhooks: properties: added: type: array - items: *716 + items: *717 deleted: type: array - items: *716 + items: *717 updated: type: array items: type: object properties: - rule: *716 + rule: *717 changes: type: object properties: @@ -233224,10 +232737,10 @@ x-webhooks: - from required: - owner - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -233305,10 +232818,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -233386,7 +232899,7 @@ x-webhooks: type: string enum: - create - alert: &910 + alert: &918 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -233507,10 +233020,10 @@ x-webhooks: type: string enum: - open - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -233716,10 +233229,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -233797,11 +233310,11 @@ x-webhooks: type: string enum: - reopen - alert: *910 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *918 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -234000,10 +233513,10 @@ x-webhooks: enum: - fixed - open - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -234021,7 +233534,7 @@ x-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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. @@ -234029,8 +233542,8 @@ x-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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -234074,18 +233587,18 @@ x-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: &911 + - assigned + alert: &919 type: object properties: - number: *123 - created_at: *130 + number: *127 + created_at: *134 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -234093,8 +233606,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *128 - html_url: *129 + url: *132 + html_url: *133 locations_url: type: string format: uri @@ -234199,10 +233712,93 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + assignee: *4 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + 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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + + 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/enterprise-cloud@latest//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: *919 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -234283,11 +233879,11 @@ x-webhooks: type: string enum: - created - alert: *911 - installation: *845 - location: *912 - organization: *846 - repository: *847 + alert: *919 + installation: *853 + location: *920 + organization: *854 + repository: *855 sender: *4 required: - location @@ -234525,11 +234121,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *919 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -234607,11 +234203,11 @@ x-webhooks: type: string enum: - reopened - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *919 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -234689,11 +234285,94 @@ x-webhooks: type: string enum: - resolved - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *919 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + 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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + + 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/enterprise-cloud@latest//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: *919 + assignee: *4 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -234771,11 +234450,11 @@ x-webhooks: type: string enum: - validated - alert: *911 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + alert: *919 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -234901,10 +234580,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *847 - enterprise: *844 - installation: *845 - organization: *846 + repository: *855 + enterprise: *852 + installation: *853 + organization: *854 sender: *4 required: - action @@ -234982,11 +234661,11 @@ x-webhooks: type: string enum: - published - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - security_advisory: &913 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + security_advisory: &921 description: The details of the security advisory, including summary, description, and severity. type: object @@ -235002,7 +234681,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *125 + cvss_severities: *129 cwes: type: array items: @@ -235169,11 +234848,11 @@ x-webhooks: type: string enum: - updated - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 - security_advisory: *913 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 + security_advisory: *921 sender: *4 required: - action @@ -235246,10 +234925,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -235266,7 +234945,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *125 + cvss_severities: *129 cwes: type: array items: @@ -235433,10 +235112,10 @@ x-webhooks: from: type: object properties: - security_and_analysis: *408 - enterprise: *844 - installation: *845 - organization: *846 + security_and_analysis: *415 + enterprise: *852 + installation: *853 + organization: *854 repository: *467 sender: *4 required: @@ -235515,12 +235194,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - sponsorship: &914 + sponsorship: &922 type: object properties: created_at: @@ -235821,12 +235500,12 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - sponsorship: *914 + sponsorship: *922 required: - action - sponsorship @@ -235914,12 +235593,12 @@ x-webhooks: type: string required: - from - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - sponsorship: *914 + sponsorship: *922 required: - action - changes @@ -235996,17 +235675,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &915 + effective_date: &923 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: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - sponsorship: *914 + sponsorship: *922 required: - action - sponsorship @@ -236080,7 +235759,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &916 + changes: &924 type: object properties: tier: @@ -236124,13 +235803,13 @@ x-webhooks: - from required: - tier - effective_date: *915 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + effective_date: *923 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - sponsorship: *914 + sponsorship: *922 required: - action - changes @@ -236207,13 +235886,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *916 - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + changes: *924 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - sponsorship: *914 + sponsorship: *922 required: - action - changes @@ -236287,10 +235966,10 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -236373,10 +236052,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -236796,15 +236475,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *844 + enterprise: *852 id: description: The unique identifier of the status. type: integer - installation: *845 + installation: *853 name: type: string - organization: *846 - repository: *847 + organization: *854 + repository: *855 sender: *4 sha: description: The Commit SHA. @@ -236913,15 +236592,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *227 - parent_issue_repo: *74 + parent_issue: *232 + parent_issue_repo: *78 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *227 - installation: *845 - organization: *846 - repository: *847 + sub_issue: *232 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -237005,15 +236684,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *227 - parent_issue_repo: *74 + parent_issue: *232 + parent_issue_repo: *78 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *227 - installation: *845 - organization: *846 - repository: *847 + sub_issue: *232 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -237097,15 +236776,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *227 - sub_issue_repo: *74 + sub_issue: *232 + sub_issue_repo: *78 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *227 - installation: *845 - organization: *846 - repository: *847 + parent_issue: *232 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -237189,15 +236868,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *227 - sub_issue_repo: *74 + sub_issue: *232 + sub_issue_repo: *78 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *227 - installation: *845 - organization: *846 - repository: *847 + parent_issue: *232 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -237274,12 +236953,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - team: &917 + team: &925 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -237502,9 +237181,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 repository: title: Repository description: A git repository @@ -237962,7 +237641,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *925 required: - action - team @@ -238038,9 +237717,9 @@ x-webhooks: type: string enum: - created - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 repository: title: Repository description: A git repository @@ -238498,7 +238177,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *925 required: - action - team @@ -238575,9 +238254,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 repository: title: Repository description: A git repository @@ -239035,7 +238714,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *925 required: - action - team @@ -239179,9 +238858,9 @@ x-webhooks: - from required: - permissions - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 repository: title: Repository description: A git repository @@ -239639,7 +239318,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *925 required: - action - changes @@ -239717,9 +239396,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *844 - installation: *845 - organization: *846 + enterprise: *852 + installation: *853 + organization: *854 repository: title: Repository description: A git repository @@ -240177,7 +239856,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *917 + team: *925 required: - action - team @@ -240253,10 +239932,10 @@ x-webhooks: type: string enum: - started - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 required: - action @@ -240329,16 +240008,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *844 + enterprise: *852 inputs: type: object nullable: true additionalProperties: true - installation: *845 - organization: *846 + installation: *853 + organization: *854 ref: type: string - repository: *847 + repository: *855 sender: *4 workflow: type: string @@ -240420,10 +240099,10 @@ x-webhooks: type: string enum: - completed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 workflow_job: allOf: @@ -240660,7 +240339,7 @@ x-webhooks: type: string required: - conclusion - deployment: *599 + deployment: *601 required: - action - repository @@ -240739,10 +240418,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 workflow_job: allOf: @@ -241002,7 +240681,7 @@ x-webhooks: required: - status - steps - deployment: *599 + deployment: *601 required: - action - repository @@ -241081,10 +240760,10 @@ x-webhooks: type: string enum: - queued - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 workflow_job: type: object @@ -241219,7 +240898,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *599 + deployment: *601 required: - action - repository @@ -241298,10 +240977,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 workflow_job: type: object @@ -241437,7 +241116,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *599 + deployment: *601 required: - action - repository @@ -241517,12 +241196,12 @@ x-webhooks: type: string enum: - completed - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - workflow: *861 + workflow: *869 workflow_run: title: Workflow Run type: object @@ -242521,12 +242200,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - workflow: *861 + workflow: *869 workflow_run: title: Workflow Run type: object @@ -243510,12 +243189,12 @@ x-webhooks: type: string enum: - requested - enterprise: *844 - installation: *845 - organization: *846 - repository: *847 + enterprise: *852 + installation: *853 + organization: *854 + repository: *855 sender: *4 - workflow: *861 + workflow: *869 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index 3e7792ece..0bcb43ed2 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.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." @@ -2344,6 +2340,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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}/actions/cache/usage": { "get": { "summary": "Get GitHub Actions cache usage for an enterprise", @@ -11582,6 +11778,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -11907,6 +12106,35 @@ "parameters": [ { "$ref": "#/components/parameters/enterprise" + }, + { + "$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": { @@ -17397,6 +17625,206 @@ "deprecated": true } }, + "/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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", @@ -35541,6 +35969,203 @@ "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/enterprise-cloud@latest//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}": { @@ -37810,6 +38435,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -41064,252 +41692,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", - "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/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - }, - "nullable": true - }, - "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", @@ -41790,1168 +42172,6 @@ "deprecated": true } }, - "/projects/columns/cards/{card_id}": { - "get": { - "summary": "Get a project card", - "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-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card" - }, - "parameters": [ - { - "$ref": "#/components/parameters/card-id" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-card" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-card" - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an existing project card", - "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-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card" - }, - "parameters": [ - { - "$ref": "#/components/parameters/card-id" - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "note": { - "description": "The project card's note", - "example": "Update all gems", - "type": "string", - "nullable": true - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - } - } - }, - "examples": { - "default": { - "summary": "Change the note on the card", - "value": { - "note": "Add payload for delete Project column" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-card" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-card" - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project card", - "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-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card" - }, - "parameters": [ - { - "$ref": "#/components/parameters/card-id" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/cards/{card_id}/moves": { - "post": { - "summary": "Move a project card", - "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-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card" - }, - "parameters": [ - { - "$ref": "#/components/parameters/card-id" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", - "example": "bottom", - "type": "string", - "pattern": "^(?:top|bottom|after:\\d+)$" - }, - "column_id": { - "description": "The unique identifier of the column the card should be moved to", - "example": 42, - "type": "integer" - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the card to the bottom of the column", - "value": { - "column_id": 42, - "position": "bottom" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "resource": { - "type": "string" - }, - "field": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "503": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", - "example": "Remaining tasks", - "type": "string" - } - }, - "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/enterprise-cloud@latest//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}/cards": { - "get": { - "summary": "List project cards", - "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-cards", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards" - }, - "parameters": [ - { - "$ref": "#/components/parameters/column-id" - }, - { - "name": "archived_state", - "description": "Filters the project cards that are returned by the card's state.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "archived", - "not_archived" - ], - "default": "not_archived" - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/project-card" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-card-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": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create a project card", - "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/create-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card" - }, - "parameters": [ - { - "$ref": "#/components/parameters/column-id" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "note": { - "description": "The project card's note", - "example": "Update all gems", - "type": "string", - "nullable": true - } - }, - "required": [ - "note" - ] - }, - { - "type": "object", - "properties": { - "content_id": { - "description": "The unique identifier of the content associated with the card", - "example": 42, - "type": "integer" - }, - "content_type": { - "description": "The piece of content associated with the card", - "example": "PullRequest", - "type": "string" - } - }, - "required": [ - "content_id", - "content_type" - ] - } - ] - }, - "examples": { - "default": { - "summary": "Create a new card", - "value": { - "note": "Add payload for delete Project column" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-card" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-card" - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/validation-error" - }, - { - "$ref": "#/components/schemas/validation-error-simple" - } - ] - } - } - } - }, - "503": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "cards", - "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/enterprise-cloud@latest//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.", - "example": "last", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$" - } - }, - "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "example": "write", - "type": "string" - } - }, - "nullable": true - }, - "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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", @@ -43627,6 +42847,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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", @@ -74937,6 +74369,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -75063,7 +74498,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" @@ -75098,6 +74533,9 @@ }, "resolution_comment": { "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + }, + "assignee": { + "$ref": "#/components/schemas/secret-scanning-alert-assignee" } }, "anyOf": [ @@ -75105,6 +74543,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -75114,6 +74557,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -75142,7 +74597,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" @@ -81762,254 +81217,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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)", @@ -90441,120 +89648,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//rest/projects/projects#get-project-for-user" + "url": "https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//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": { @@ -90565,6 +89953,9 @@ }, "401": { "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -94884,11 +94275,104 @@ } } }, - "dependabot-alert-dismissed": { + "dependabot-alert-dismissed": { + "post": { + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert was manually closed.", + "operationId": "dependabot-alert/dismissed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_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-dependabot-alert-dismissed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "dependabot_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "dependabot-alert-fixed": { "post": { "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", - "description": "A Dependabot alert was manually closed.", - "operationId": "dependabot-alert/dismissed", + "description": "A manifest file change removed a vulnerability.", + "operationId": "dependabot-alert/fixed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, @@ -94955,7 +94439,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" + "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" } } } @@ -94977,11 +94461,11 @@ } } }, - "dependabot-alert-fixed": { + "dependabot-alert-reintroduced": { "post": { "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", - "description": "A manifest file change removed a vulnerability.", - "operationId": "dependabot-alert/fixed", + "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", + "operationId": "dependabot-alert/reintroduced", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, @@ -95048,7 +94532,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" + "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" } } } @@ -95070,11 +94554,11 @@ } } }, - "dependabot-alert-reintroduced": { + "dependabot-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", - "operationId": "dependabot-alert/reintroduced", + "description": "A Dependabot alert was manually reopened.", + "operationId": "dependabot-alert/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, @@ -95141,7 +94625,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" + "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" } } } @@ -95163,13 +94647,13 @@ } } }, - "dependabot-alert-reopened": { + "deploy-key-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", - "description": "A Dependabot alert was manually reopened.", - "operationId": "dependabot-alert/reopened", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was created.", + "operationId": "deploy-key/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -95234,7 +94718,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" + "$ref": "#/components/schemas/webhook-deploy-key-created" } } } @@ -95247,7 +94731,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "deploy_key", "supported-webhook-types": [ "repository", "organization", @@ -95256,11 +94740,11 @@ } } }, - "deploy-key-created": { + "deploy-key-deleted": { "post": { "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was created.", - "operationId": "deploy-key/created", + "description": "A deploy key was deleted.", + "operationId": "deploy-key/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" }, @@ -95327,7 +94811,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deploy-key-created" + "$ref": "#/components/schemas/webhook-deploy-key-deleted" } } } @@ -95349,13 +94833,13 @@ } } }, - "deploy-key-deleted": { + "deployment-created": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was deleted.", - "operationId": "deploy-key/deleted", + "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment was created.", + "operationId": "deployment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment" }, "parameters": [ { @@ -95420,7 +94904,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deploy-key-deleted" + "$ref": "#/components/schemas/webhook-deployment-created" } } } @@ -95433,7 +94917,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy_key", + "subcategory": "deployment", "supported-webhook-types": [ "repository", "organization", @@ -95442,13 +94926,13 @@ } } }, - "deployment-created": { + "deployment-protection-rule-requested": { "post": { - "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment was created.", - "operationId": "deployment/created", + "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment protection rule was requested for an environment.", + "operationId": "deployment-protection-rule/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule" }, "parameters": [ { @@ -95513,7 +94997,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-created" + "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" } } } @@ -95526,22 +95010,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment", + "subcategory": "deployment_protection_rule", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "deployment-protection-rule-requested": { + "deployment-review-approved": { "post": { - "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment protection rule was requested for an environment.", - "operationId": "deployment-protection-rule/requested", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was approved.", + "operationId": "deployment-review/approved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -95606,7 +95088,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" + "$ref": "#/components/schemas/webhook-deployment-review-approved" } } } @@ -95619,18 +95101,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_protection_rule", + "subcategory": "deployment_review", "supported-webhook-types": [ "app" ] } } }, - "deployment-review-approved": { + "deployment-review-rejected": { "post": { "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was approved.", - "operationId": "deployment-review/approved", + "description": "A deployment review was rejected.", + "operationId": "deployment-review/rejected", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" }, @@ -95697,7 +95179,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-approved" + "$ref": "#/components/schemas/webhook-deployment-review-rejected" } } } @@ -95717,11 +95199,11 @@ } } }, - "deployment-review-rejected": { + "deployment-review-requested": { "post": { "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was rejected.", - "operationId": "deployment-review/rejected", + "description": "A deployment review was requested.", + "operationId": "deployment-review/requested", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" }, @@ -95788,7 +95270,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-rejected" + "$ref": "#/components/schemas/webhook-deployment-review-requested" } } } @@ -95808,13 +95290,13 @@ } } }, - "deployment-review-requested": { + "deployment-status-created": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was requested.", - "operationId": "deployment-review/requested", + "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n> [!NOTE]\n> A webhook event is not fired for deployment statuses with an `inactive` state.", + "description": "A new deployment status was created.", + "operationId": "deployment-status/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status" }, "parameters": [ { @@ -95879,7 +95361,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-requested" + "$ref": "#/components/schemas/webhook-deployment-status-created" } } } @@ -95892,20 +95374,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "deployment_status", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-status-created": { + "discussion-answered": { "post": { - "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n> [!NOTE]\n> A webhook event is not fired for deployment statuses with an `inactive` state.", - "description": "A new deployment status was created.", - "operationId": "deployment-status/created", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on the discussion was marked as the answer.", + "operationId": "discussion/answered", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -95970,7 +95454,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-status-created" + "$ref": "#/components/schemas/webhook-discussion-answered" } } } @@ -95983,7 +95467,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_status", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -95992,11 +95476,11 @@ } } }, - "discussion-answered": { + "discussion-category-changed": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A comment on the discussion was marked as the answer.", - "operationId": "discussion/answered", + "description": "The category of a discussion was changed.", + "operationId": "discussion/category-changed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -96063,7 +95547,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-answered" + "$ref": "#/components/schemas/webhook-discussion-category-changed" } } } @@ -96085,11 +95569,11 @@ } } }, - "discussion-category-changed": { + "discussion-closed": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "The category of a discussion was changed.", - "operationId": "discussion/category-changed", + "description": "A discussion was closed.", + "operationId": "discussion/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -96113,7 +95597,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "discussions", "schema": { "type": "string" } @@ -96156,7 +95640,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-category-changed" + "$ref": "#/components/schemas/webhook-discussion-closed" } } } @@ -96178,13 +95662,13 @@ } } }, - "discussion-closed": { + "discussion-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was closed.", - "operationId": "discussion/closed", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was created.", + "operationId": "discussion-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -96206,7 +95690,100 @@ { "name": "X-Github-Event", "in": "header", - "example": "discussions", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-comment-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-comment-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was deleted.", + "operationId": "discussion-comment/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "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" } @@ -96249,7 +95826,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-closed" + "$ref": "#/components/schemas/webhook-discussion-comment-deleted" } } } @@ -96262,7 +95839,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "discussion_comment", "supported-webhook-types": [ "repository", "organization", @@ -96271,11 +95848,11 @@ } } }, - "discussion-comment-created": { + "discussion-comment-edited": { "post": { "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A comment on a discussion was created.", - "operationId": "discussion-comment/created", + "description": "A comment on a discussion was edited.", + "operationId": "discussion-comment/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" }, @@ -96342,7 +95919,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-created" + "$ref": "#/components/schemas/webhook-discussion-comment-edited" } } } @@ -96364,13 +95941,13 @@ } } }, - "discussion-comment-deleted": { + "discussion-created": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A comment on a discussion was deleted.", - "operationId": "discussion-comment/deleted", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was created.", + "operationId": "discussion/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -96435,7 +96012,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-deleted" + "$ref": "#/components/schemas/webhook-discussion-created" } } } @@ -96448,7 +96025,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -96457,13 +96034,13 @@ } } }, - "discussion-comment-edited": { + "discussion-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A comment on a discussion was edited.", - "operationId": "discussion-comment/edited", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was deleted.", + "operationId": "discussion/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -96528,7 +96105,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-edited" + "$ref": "#/components/schemas/webhook-discussion-deleted" } } } @@ -96541,7 +96118,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -96550,11 +96127,11 @@ } } }, - "discussion-created": { + "discussion-edited": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was created.", - "operationId": "discussion/created", + "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", + "operationId": "discussion/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -96621,7 +96198,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-created" + "$ref": "#/components/schemas/webhook-discussion-edited" } } } @@ -96643,11 +96220,11 @@ } } }, - "discussion-deleted": { + "discussion-labeled": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was deleted.", - "operationId": "discussion/deleted", + "description": "A label was added to a discussion.", + "operationId": "discussion/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -96714,7 +96291,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-deleted" + "$ref": "#/components/schemas/webhook-discussion-labeled" } } } @@ -96736,11 +96313,11 @@ } } }, - "discussion-edited": { + "discussion-locked": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", - "operationId": "discussion/edited", + "description": "A discussion was locked.", + "operationId": "discussion/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -96807,7 +96384,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-edited" + "$ref": "#/components/schemas/webhook-discussion-locked" } } } @@ -96829,11 +96406,11 @@ } } }, - "discussion-labeled": { + "discussion-pinned": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A label was added to a discussion.", - "operationId": "discussion/labeled", + "description": "A discussion was pinned.", + "operationId": "discussion/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -96900,7 +96477,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-labeled" + "$ref": "#/components/schemas/webhook-discussion-pinned" } } } @@ -96922,11 +96499,11 @@ } } }, - "discussion-locked": { + "discussion-reopened": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was locked.", - "operationId": "discussion/locked", + "description": "A discussion was reopened.", + "operationId": "discussion/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -96950,7 +96527,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "discussions", "schema": { "type": "string" } @@ -96993,7 +96570,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-locked" + "$ref": "#/components/schemas/webhook-discussion-reopened" } } } @@ -97015,11 +96592,11 @@ } } }, - "discussion-pinned": { + "discussion-transferred": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was pinned.", - "operationId": "discussion/pinned", + "description": "A discussion was transferred to another repository.", + "operationId": "discussion/transferred", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -97086,7 +96663,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-pinned" + "$ref": "#/components/schemas/webhook-discussion-transferred" } } } @@ -97108,11 +96685,11 @@ } } }, - "discussion-reopened": { + "discussion-unanswered": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was reopened.", - "operationId": "discussion/reopened", + "description": "A comment on the discussion was unmarked as the answer.", + "operationId": "discussion/unanswered", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -97136,7 +96713,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "discussions", + "example": "issues", "schema": { "type": "string" } @@ -97179,7 +96756,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-reopened" + "$ref": "#/components/schemas/webhook-discussion-unanswered" } } } @@ -97201,11 +96778,11 @@ } } }, - "discussion-transferred": { + "discussion-unlabeled": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was transferred to another repository.", - "operationId": "discussion/transferred", + "description": "A label was removed from a discussion.", + "operationId": "discussion/unlabeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -97272,7 +96849,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-transferred" + "$ref": "#/components/schemas/webhook-discussion-unlabeled" } } } @@ -97294,11 +96871,11 @@ } } }, - "discussion-unanswered": { + "discussion-unlocked": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A comment on the discussion was unmarked as the answer.", - "operationId": "discussion/unanswered", + "description": "A discussion was unlocked.", + "operationId": "discussion/unlocked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -97365,7 +96942,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unanswered" + "$ref": "#/components/schemas/webhook-discussion-unlocked" } } } @@ -97387,11 +96964,11 @@ } } }, - "discussion-unlabeled": { + "discussion-unpinned": { "post": { "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A label was removed from a discussion.", - "operationId": "discussion/unlabeled", + "description": "A discussion was unpinned.", + "operationId": "discussion/unpinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -97458,7 +97035,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unlabeled" + "$ref": "#/components/schemas/webhook-discussion-unpinned" } } } @@ -97480,13 +97057,13 @@ } } }, - "discussion-unlocked": { + "dismissal-request-code-scanning-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was unlocked.", - "operationId": "discussion/unlocked", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", + "description": "A code scanning alert dismissal request was created.", + "operationId": "dismissal-request-code-scanning/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { @@ -97551,7 +97128,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unlocked" + "$ref": "#/components/schemas/webhook-exemption-request-created" } } } @@ -97562,9 +97139,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "dismissal_request_code_scanning", "supported-webhook-types": [ "repository", "organization", @@ -97573,13 +97150,13 @@ } } }, - "discussion-unpinned": { + "dismissal-request-code-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", - "description": "A discussion was unpinned.", - "operationId": "discussion/unpinned", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", + "description": "A code scanning alert dismissal response was submitted.", + "operationId": "dismissal-request-code-scanning/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { @@ -97644,7 +97221,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unpinned" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } @@ -97655,9 +97232,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "dismissal_request_code_scanning", "supported-webhook-types": [ "repository", "organization", @@ -97666,13 +97243,13 @@ } } }, - "dismissal-request-code-scanning-created": { + "dismissal-request-secret-scanning-cancelled": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", - "description": "A code scanning alert dismissal request was created.", - "operationId": "dismissal-request-code-scanning/created", + "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", + "description": "A secret scanning alert dismissal request was canceled.", + "operationId": "dismissal-request-secret-scanning/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -97737,7 +97314,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-created" + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" } } } @@ -97750,7 +97327,7 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "dismissal_request_code_scanning", + "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -97759,13 +97336,13 @@ } } }, - "dismissal-request-code-scanning-response-submitted": { + "dismissal-request-secret-scanning-completed": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.", - "description": "A code scanning alert dismissal response was submitted.", - "operationId": "dismissal-request-code-scanning/response-submitted", + "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", + "description": "A secret scanning alert dismissal request was completed.", + "operationId": "dismissal-request-secret-scanning/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -97830,7 +97407,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + "$ref": "#/components/schemas/webhook-exemption-request-completed" } } } @@ -97843,7 +97420,7 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "dismissal_request_code_scanning", + "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -97852,11 +97429,11 @@ } } }, - "dismissal-request-secret-scanning-cancelled": { + "dismissal-request-secret-scanning-created": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal request was canceled.", - "operationId": "dismissal-request-secret-scanning/cancelled", + "description": "A secret scanning alert dismissal request was created.", + "operationId": "dismissal-request-secret-scanning/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, @@ -97923,7 +97500,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-cancelled" + "$ref": "#/components/schemas/webhook-exemption-request-created" } } } @@ -97945,11 +97522,11 @@ } } }, - "dismissal-request-secret-scanning-completed": { + "dismissal-request-secret-scanning-response-dismissed": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal request was completed.", - "operationId": "dismissal-request-secret-scanning/completed", + "description": "A secret scanning alert dismissal response was dismissed.", + "operationId": "dismissal-request-secret-scanning/response-dismissed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, @@ -98016,7 +97593,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-completed" + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" } } } @@ -98038,11 +97615,11 @@ } } }, - "dismissal-request-secret-scanning-created": { + "dismissal-request-secret-scanning-response-submitted": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal request was created.", - "operationId": "dismissal-request-secret-scanning/created", + "description": "A secret scanning alert dismissal response was submitted.", + "operationId": "dismissal-request-secret-scanning/response-submitted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, @@ -98109,7 +97686,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-created" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } @@ -98131,13 +97708,13 @@ } } }, - "dismissal-request-secret-scanning-response-dismissed": { + "exemption-request-push-ruleset-cancelled": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal response was dismissed.", - "operationId": "dismissal-request-secret-scanning/response-dismissed", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "description": "A push ruleset bypass request was cancelled.", + "operationId": "exemption-request-push-ruleset/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, "parameters": [ { @@ -98202,7 +97779,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" } } } @@ -98215,7 +97792,7 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "dismissal_request_secret_scanning", + "subcategory": "exemption_request_push_ruleset", "supported-webhook-types": [ "repository", "organization", @@ -98224,13 +97801,13 @@ } } }, - "dismissal-request-secret-scanning-response-submitted": { + "exemption-request-push-ruleset-completed": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal response was submitted.", - "operationId": "dismissal-request-secret-scanning/response-submitted", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "description": "A push ruleset bypass request was completed.", + "operationId": "exemption-request-push-ruleset/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, "parameters": [ { @@ -98295,7 +97872,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + "$ref": "#/components/schemas/webhook-exemption-request-completed" } } } @@ -98308,7 +97885,7 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "dismissal_request_secret_scanning", + "subcategory": "exemption_request_push_ruleset", "supported-webhook-types": [ "repository", "organization", @@ -98317,11 +97894,11 @@ } } }, - "exemption-request-push-ruleset-cancelled": { + "exemption-request-push-ruleset-created": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A push ruleset bypass request was cancelled.", - "operationId": "exemption-request-push-ruleset/cancelled", + "description": "A push ruleset bypass request was created.", + "operationId": "exemption-request-push-ruleset/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, @@ -98388,7 +97965,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-cancelled" + "$ref": "#/components/schemas/webhook-exemption-request-created" } } } @@ -98410,11 +97987,11 @@ } } }, - "exemption-request-push-ruleset-completed": { + "exemption-request-push-ruleset-response-dismissed": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A push ruleset bypass request was completed.", - "operationId": "exemption-request-push-ruleset/completed", + "description": "A push ruleset bypass response was dismissed.", + "operationId": "exemption-request-push-ruleset/response-dismissed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, @@ -98481,7 +98058,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-completed" + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" } } } @@ -98503,11 +98080,11 @@ } } }, - "exemption-request-push-ruleset-created": { + "exemption-request-push-ruleset-response-submitted": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A push ruleset bypass request was created.", - "operationId": "exemption-request-push-ruleset/created", + "description": "A response either approving or rejecting the push ruleset bypass request was submitted.", + "operationId": "exemption-request-push-ruleset/response-submitted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, @@ -98574,7 +98151,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-created" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } @@ -98596,13 +98173,12 @@ } } }, - "exemption-request-push-ruleset-response-dismissed": { + "fork": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A push ruleset bypass response was dismissed.", - "operationId": "exemption-request-push-ruleset/response-dismissed", + "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "fork", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork" }, "parameters": [ { @@ -98667,7 +98243,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" + "$ref": "#/components/schemas/webhook-fork" } } } @@ -98678,10 +98254,11 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "webhooks", - "subcategory": "exemption_request_push_ruleset", + "subcategory": "fork", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -98689,13 +98266,13 @@ } } }, - "exemption-request-push-ruleset-response-submitted": { + "github-app-authorization-revoked": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A response either approving or rejecting the push ruleset bypass request was submitted.", - "operationId": "exemption-request-push-ruleset/response-submitted", + "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", + "description": "Someone revoked their authorization of a GitHub App.", + "operationId": "github-app-authorization/revoked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization" }, "parameters": [ { @@ -98760,7 +98337,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" } } } @@ -98771,23 +98348,21 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "webhooks", - "subcategory": "exemption_request_push_ruleset", + "subcategory": "github_app_authorization", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "fork": { + "gollum": { "post": { - "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "fork", + "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "gollum", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum" }, "parameters": [ { @@ -98852,7 +98427,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-fork" + "$ref": "#/components/schemas/webhook-gollum" } } } @@ -98865,9 +98440,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "fork", + "subcategory": "gollum", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -98875,103 +98449,13 @@ } } }, - "github-app-authorization-revoked": { - "post": { - "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", - "description": "Someone revoked their authorization of a GitHub App.", - "operationId": "github-app-authorization/revoked", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization" - }, - "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-github-app-authorization-revoked" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "github_app_authorization", - "supported-webhook-types": [ - "app" - ] - } - } - }, - "gollum": { + "installation-created": { "post": { - "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "gollum", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Someone installed a GitHub App on a user or organization account.", + "operationId": "installation/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -99036,7 +98520,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-gollum" + "$ref": "#/components/schemas/webhook-installation-created" } } } @@ -99049,20 +98533,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "gollum", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "installation-created": { + "installation-deleted": { "post": { "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone installed a GitHub App on a user or organization account.", - "operationId": "installation/created", + "description": "Someone uninstalled a GitHub App from their user or organization account.", + "operationId": "installation/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, @@ -99129,7 +98611,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-created" + "$ref": "#/components/schemas/webhook-installation-deleted" } } } @@ -99149,11 +98631,11 @@ } } }, - "installation-deleted": { + "installation-new-permissions-accepted": { "post": { "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone uninstalled a GitHub App from their user or organization account.", - "operationId": "installation/deleted", + "description": "Someone granted new permissions to a GitHub App.", + "operationId": "installation/new-permissions-accepted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, @@ -99220,7 +98702,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-deleted" + "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" } } } @@ -99240,13 +98722,13 @@ } } }, - "installation-new-permissions-accepted": { + "installation-repositories-added": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone granted new permissions to a GitHub App.", - "operationId": "installation/new-permissions-accepted", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "A GitHub App installation was granted access to one or more repositories.", + "operationId": "installation-repositories/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -99311,7 +98793,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" + "$ref": "#/components/schemas/webhook-installation-repositories-added" } } } @@ -99324,18 +98806,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "installation_repositories", "supported-webhook-types": [ "app" ] } } }, - "installation-repositories-added": { + "installation-repositories-removed": { "post": { "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "A GitHub App installation was granted access to one or more repositories.", - "operationId": "installation-repositories/added", + "description": "Access to one or more repositories was revoked for a GitHub App installation.", + "operationId": "installation-repositories/removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" }, @@ -99402,7 +98884,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-repositories-added" + "$ref": "#/components/schemas/webhook-installation-repositories-removed" } } } @@ -99422,13 +98904,13 @@ } } }, - "installation-repositories-removed": { + "installation-suspend": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Access to one or more repositories was revoked for a GitHub App installation.", - "operationId": "installation-repositories/removed", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Someone blocked access by a GitHub App to their user or organization account.", + "operationId": "installation/suspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -99493,7 +98975,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-repositories-removed" + "$ref": "#/components/schemas/webhook-installation-suspend" } } } @@ -99506,20 +98988,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_repositories", + "subcategory": "installation", "supported-webhook-types": [ "app" ] } } }, - "installation-suspend": { + "installation-target-renamed": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone blocked access by a GitHub App to their user or organization account.", - "operationId": "installation/suspend", + "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", + "operationId": "installation-target/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target" }, "parameters": [ { @@ -99584,7 +99066,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-suspend" + "$ref": "#/components/schemas/webhook-installation-target-renamed" } } } @@ -99597,20 +99079,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "installation_target", "supported-webhook-types": [ "app" ] } } }, - "installation-target-renamed": { + "installation-unsuspend": { "post": { - "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", - "operationId": "installation-target/renamed", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", + "operationId": "installation/unsuspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -99675,7 +99157,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-target-renamed" + "$ref": "#/components/schemas/webhook-installation-unsuspend" } } } @@ -99688,20 +99170,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_target", + "subcategory": "installation", "supported-webhook-types": [ "app" ] } } }, - "installation-unsuspend": { + "issue-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", - "operationId": "installation/unsuspend", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was created.", + "operationId": "issue-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -99766,7 +99248,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-unsuspend" + "$ref": "#/components/schemas/webhook-issue-comment-created" } } } @@ -99779,18 +99261,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "issue_comment", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "issue-comment-created": { + "issue-comment-deleted": { "post": { "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was created.", - "operationId": "issue-comment/created", + "description": "A comment on an issue or pull request was deleted.", + "operationId": "issue-comment/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, @@ -99857,7 +99341,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-created" + "$ref": "#/components/schemas/webhook-issue-comment-deleted" } } } @@ -99879,11 +99363,11 @@ } } }, - "issue-comment-deleted": { + "issue-comment-edited": { "post": { "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was deleted.", - "operationId": "issue-comment/deleted", + "description": "A comment on an issue or pull request was edited.", + "operationId": "issue-comment/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, @@ -99950,7 +99434,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-deleted" + "$ref": "#/components/schemas/webhook-issue-comment-edited" } } } @@ -99972,13 +99456,13 @@ } } }, - "issue-comment-edited": { + "issue-dependencies-blocked-by-added": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was edited.", - "operationId": "issue-comment/edited", + "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "An issue was marked as blocked by another issue.", + "operationId": "issue-dependencies/blocked-by-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { @@ -100043,7 +99527,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-edited" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" } } } @@ -100056,7 +99540,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "issue-dependencies", "supported-webhook-types": [ "repository", "organization", @@ -100065,11 +99549,11 @@ } } }, - "issue-dependencies-blocked-by-added": { + "issue-dependencies-blocked-by-removed": { "post": { "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "An issue was marked as blocked by another issue.", - "operationId": "issue-dependencies/blocked-by-added", + "description": "The blocked by relationship between an issue and another issue was removed.", + "operationId": "issue-dependencies/blocked-by-removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, @@ -100136,7 +99620,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" } } } @@ -100158,11 +99642,11 @@ } } }, - "issue-dependencies-blocked-by-removed": { + "issue-dependencies-blocking-added": { "post": { "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "The blocked by relationship between an issue and another issue was removed.", - "operationId": "issue-dependencies/blocked-by-removed", + "description": "An issue was marked as blocking another issue.", + "operationId": "issue-dependencies/blocking-added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, @@ -100229,7 +99713,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" } } } @@ -100251,11 +99735,11 @@ } } }, - "issue-dependencies-blocking-added": { + "issue-dependencies-blocking-removed": { "post": { "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "An issue was marked as blocking another issue.", - "operationId": "issue-dependencies/blocking-added", + "description": "The blocking relationship between an issue and another issue was removed.", + "operationId": "issue-dependencies/blocking-removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" }, @@ -100322,7 +99806,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" } } } @@ -100344,13 +99828,13 @@ } } }, - "issue-dependencies-blocking-removed": { + "issues-assigned": { "post": { - "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", - "description": "The blocking relationship between an issue and another issue was removed.", - "operationId": "issue-dependencies/blocking-removed", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was assigned to a user.", + "operationId": "issues/assigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue-dependencies" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -100415,7 +99899,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" + "$ref": "#/components/schemas/webhook-issues-assigned" } } } @@ -100428,7 +99912,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue-dependencies", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -100437,11 +99921,11 @@ } } }, - "issues-assigned": { + "issues-closed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was assigned to a user.", - "operationId": "issues/assigned", + "description": "An issue was closed.", + "operationId": "issues/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100508,7 +99992,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-issues-closed" } } } @@ -100530,11 +100014,11 @@ } } }, - "issues-closed": { + "issues-deleted": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was closed.", - "operationId": "issues/closed", + "description": "An issue was deleted.", + "operationId": "issues/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100601,7 +100085,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issues-deleted" } } } @@ -100623,11 +100107,11 @@ } } }, - "issues-deleted": { + "issues-demilestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was deleted.", - "operationId": "issues/deleted", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100694,7 +100178,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issues-demilestoned" } } } @@ -100716,11 +100200,11 @@ } } }, - "issues-demilestoned": { + "issues-edited": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was removed from a milestone.", - "operationId": "issues/demilestoned", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100787,7 +100271,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issues-edited" } } } @@ -100809,11 +100293,11 @@ } } }, - "issues-edited": { + "issues-labeled": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "The title or body on an issue was edited.", - "operationId": "issues/edited", + "description": "A label was added to an issue.", + "operationId": "issues/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100880,7 +100364,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issues-labeled" } } } @@ -100902,11 +100386,11 @@ } } }, - "issues-labeled": { + "issues-locked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was added to an issue.", - "operationId": "issues/labeled", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -100973,7 +100457,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-locked" } } } @@ -100995,11 +100479,11 @@ } } }, - "issues-locked": { + "issues-milestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/locked", + "description": "An issue was added to a milestone.", + "operationId": "issues/milestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101066,7 +100550,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-milestoned" } } } @@ -101088,11 +100572,11 @@ } } }, - "issues-milestoned": { + "issues-opened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was added to a milestone.", - "operationId": "issues/milestoned", + "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", + "operationId": "issues/opened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101159,7 +100643,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-opened" } } } @@ -101181,11 +100665,11 @@ } } }, - "issues-opened": { + "issues-pinned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", - "operationId": "issues/opened", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101252,7 +100736,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-pinned" } } } @@ -101274,11 +100758,11 @@ } } }, - "issues-pinned": { + "issues-reopened": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/pinned", + "description": "A closed issue was reopened.", + "operationId": "issues/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101345,7 +100829,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-reopened" } } } @@ -101367,11 +100851,11 @@ } } }, - "issues-reopened": { + "issues-transferred": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A closed issue was reopened.", - "operationId": "issues/reopened", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "operationId": "issues/transferred", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101438,7 +100922,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-transferred" } } } @@ -101460,11 +100944,11 @@ } } }, - "issues-transferred": { + "issues-typed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", - "operationId": "issues/transferred", + "description": "An issue type was added to an issue.", + "operationId": "issues/typed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101531,7 +101015,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-typed" } } } @@ -101553,11 +101037,11 @@ } } }, - "issues-typed": { + "issues-unassigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue type was added to an issue.", - "operationId": "issues/typed", + "description": "A user was unassigned from an issue.", + "operationId": "issues/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101624,7 +101108,100 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-typed" + "$ref": "#/components/schemas/webhook-issues-unassigned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-unlabeled": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A label was removed from an issue.", + "operationId": "issues/unlabeled", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "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-issues-unlabeled" } } } @@ -101646,11 +101223,11 @@ } } }, - "issues-unassigned": { + "issues-unlocked": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A user was unassigned from an issue.", - "operationId": "issues/unassigned", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/unlocked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101717,7 +101294,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-unlocked" } } } @@ -101739,11 +101316,11 @@ } } }, - "issues-unlabeled": { + "issues-unpinned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was removed from an issue.", - "operationId": "issues/unlabeled", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/unpinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101810,7 +101387,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-issues-unpinned" } } } @@ -101832,11 +101409,11 @@ } } }, - "issues-unlocked": { + "issues-untyped": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/unlocked", + "description": "An issue type was removed from an issue.", + "operationId": "issues/untyped", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -101903,7 +101480,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-issues-untyped" } } } @@ -101925,13 +101502,13 @@ } } }, - "issues-unpinned": { + "label-created": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/unpinned", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was created.", + "operationId": "label/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -101996,7 +101573,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-label-created" } } } @@ -102009,7 +101586,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "label", "supported-webhook-types": [ "repository", "organization", @@ -102018,13 +101595,13 @@ } } }, - "issues-untyped": { + "label-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue type was removed from an issue.", - "operationId": "issues/untyped", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was deleted.", + "operationId": "label/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -102089,7 +101666,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-untyped" + "$ref": "#/components/schemas/webhook-label-deleted" } } } @@ -102102,7 +101679,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "label", "supported-webhook-types": [ "repository", "organization", @@ -102111,11 +101688,11 @@ } } }, - "label-created": { + "label-edited": { "post": { "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was created.", - "operationId": "label/created", + "description": "A label's name, description, or color was changed.", + "operationId": "label/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, @@ -102182,7 +101759,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-label-edited" } } } @@ -102204,13 +101781,13 @@ } } }, - "label-deleted": { + "marketplace-purchase-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was deleted.", - "operationId": "label/deleted", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -102275,7 +101852,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" } } } @@ -102288,22 +101865,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "repository", - "organization", - "app" + "marketplace" ] } } }, - "label-edited": { + "marketplace-purchase-changed": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label's name, description, or color was changed.", - "operationId": "label/edited", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -102368,7 +101943,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" } } } @@ -102381,20 +101956,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "repository", - "organization", - "app" + "marketplace" ] } } }, - "marketplace-purchase-cancelled": { + "marketplace-purchase-pending-change": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/cancelled", + "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", + "operationId": "marketplace-purchase/pending-change", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -102461,7 +102034,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" } } } @@ -102481,11 +102054,11 @@ } } }, - "marketplace-purchase-changed": { + "marketplace-purchase-pending-change-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/changed", + "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", + "operationId": "marketplace-purchase/pending-change-cancelled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -102552,7 +102125,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" } } } @@ -102572,11 +102145,11 @@ } } }, - "marketplace-purchase-pending-change": { + "marketplace-purchase-purchased": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", - "operationId": "marketplace-purchase/pending-change", + "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/purchased", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, @@ -102643,7 +102216,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" + "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" } } } @@ -102663,13 +102236,13 @@ } } }, - "marketplace-purchase-pending-change-cancelled": { + "member-added": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", - "operationId": "marketplace-purchase/pending-change-cancelled", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A GitHub user accepted an invitation to a repository.", + "operationId": "member/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -102734,7 +102307,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" + "$ref": "#/components/schemas/webhook-member-added" } } } @@ -102747,20 +102320,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "member", "supported-webhook-types": [ - "marketplace" + "business", + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-purchased": { + "member-edited": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/purchased", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "Permissions were changed for a collaborator on a repository.", + "operationId": "member/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -102825,7 +102401,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + "$ref": "#/components/schemas/webhook-member-edited" } } } @@ -102838,18 +102414,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "member", "supported-webhook-types": [ - "marketplace" + "business", + "repository", + "organization", + "app" ] } } }, - "member-added": { + "member-removed": { "post": { "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A GitHub user accepted an invitation to a repository.", - "operationId": "member/added", + "description": "A collaborator was removed from a repository.", + "operationId": "member/removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" }, @@ -102916,7 +102495,101 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-added" + "$ref": "#/components/schemas/webhook-member-removed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "member", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "membership-added": { + "post": { + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was added to a team.", + "operationId": "membership/added", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-membership-added" } } } @@ -102929,117 +102602,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "membership", "supported-webhook-types": [ - "business", - "repository", "organization", - "app" - ] - } - } - }, - "member-edited": { - "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "Permissions were changed for a collaborator on a repository.", - "operationId": "member/edited", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" - }, - "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-member-edited" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "member", - "supported-webhook-types": [ "business", - "repository", - "organization", "app" ] } } }, - "member-removed": { + "membership-removed": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A collaborator was removed from a repository.", - "operationId": "member/removed", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", + "operationId": "membership/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -103104,7 +102682,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-removed" + "$ref": "#/components/schemas/webhook-membership-removed" } } } @@ -103117,23 +102695,25 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "membership", "supported-webhook-types": [ - "business", - "repository", "organization", + "business", "app" ] } } }, - "membership-added": { + "merge-group-checks-requested": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was added to a team.", - "operationId": "membership/added", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", + "operationId": "merge-group/checks-requested", + "tags": [ + "merge-queue" + ], "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { @@ -103198,7 +102778,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-added" + "$ref": "#/components/schemas/webhook-merge-group-checks-requested" } } } @@ -103211,22 +102791,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "merge_group", "supported-webhook-types": [ - "organization", - "business", "app" ] } } }, - "membership-removed": { + "merge-group-destroyed": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was removed from a team.", - "operationId": "membership/removed", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", + "operationId": "merge-group/destroyed", + "tags": [ + "merge-queue" + ], "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { @@ -103291,7 +102872,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-removed" + "$ref": "#/components/schemas/webhook-merge-group-destroyed" } } } @@ -103304,25 +102885,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "merge_group", "supported-webhook-types": [ - "organization", - "business", "app" ] } } }, - "merge-group-checks-requested": { + "meta-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", - "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", - "operationId": "merge-group/checks-requested", - "tags": [ - "merge-queue" - ], + "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", + "description": "The webhook was deleted.", + "operationId": "meta/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta" }, "parameters": [ { @@ -103387,7 +102963,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-merge-group-checks-requested" + "$ref": "#/components/schemas/webhook-meta-deleted" } } } @@ -103400,23 +102976,24 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "merge_group", + "subcategory": "meta", "supported-webhook-types": [ + "marketplace", + "business", + "repository", + "organization", "app" ] } } }, - "merge-group-destroyed": { + "milestone-closed": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", - "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", - "operationId": "merge-group/destroyed", - "tags": [ - "merge-queue" - ], + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was closed.", + "operationId": "milestone/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -103481,7 +103058,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-merge-group-destroyed" + "$ref": "#/components/schemas/webhook-milestone-closed" } } } @@ -103494,20 +103071,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "merge_group", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "meta-deleted": { + "milestone-created": { "post": { - "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", - "description": "The webhook was deleted.", - "operationId": "meta/deleted", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was created.", + "operationId": "milestone/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -103572,7 +103151,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-meta-deleted" + "$ref": "#/components/schemas/webhook-milestone-created" } } } @@ -103585,10 +103164,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "meta", + "subcategory": "milestone", "supported-webhook-types": [ - "marketplace", - "business", "repository", "organization", "app" @@ -103596,11 +103173,11 @@ } } }, - "milestone-closed": { + "milestone-deleted": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was closed.", - "operationId": "milestone/closed", + "description": "A milestone was deleted.", + "operationId": "milestone/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, @@ -103667,7 +103244,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-closed" + "$ref": "#/components/schemas/webhook-milestone-deleted" } } } @@ -103689,11 +103266,11 @@ } } }, - "milestone-created": { + "milestone-edited": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\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 edited.", + "operationId": "milestone/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, @@ -103760,7 +103337,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-created" + "$ref": "#/components/schemas/webhook-milestone-edited" } } } @@ -103782,11 +103359,11 @@ } } }, - "milestone-deleted": { + "milestone-opened": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was deleted.", - "operationId": "milestone/deleted", + "description": "A milestone was opened.", + "operationId": "milestone/opened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, @@ -103853,7 +103430,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-deleted" + "$ref": "#/components/schemas/webhook-milestone-opened" } } } @@ -103875,13 +103452,13 @@ } } }, - "milestone-edited": { + "org-block-blocked": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was edited.", - "operationId": "milestone/edited", + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A user was blocked from the organization.", + "operationId": "org-block/blocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { @@ -103946,7 +103523,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-edited" + "$ref": "#/components/schemas/webhook-org-block-blocked" } } } @@ -103959,22 +103536,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "org_block", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "milestone-opened": { + "org-block-unblocked": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\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/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A previously blocked user was unblocked from the organization.", + "operationId": "org-block/unblocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { @@ -104039,7 +103616,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-opened" + "$ref": "#/components/schemas/webhook-org-block-unblocked" } } } @@ -104052,22 +103629,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "org_block", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "org-block-blocked": { + "organization-custom-property-created": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A user was blocked from the organization.", - "operationId": "org-block/blocked", + "summary": "This event occurs when there is activity relating to an organization custom property.", + "description": "A new organization custom property was created.", + "operationId": "organization-custom-property/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -104132,7 +103709,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-org-block-blocked" + "$ref": "#/components/schemas/webhook-organization-custom-property-created" } } } @@ -104143,24 +103720,22 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "org_block", + "subcategory": "organization_custom_property", "supported-webhook-types": [ - "organization", - "business", - "app" + "business" ] } } }, - "org-block-unblocked": { + "organization-custom-property-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/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A previously blocked user was unblocked from the organization.", - "operationId": "org-block/unblocked", + "summary": "This event occurs when there is activity relating to an organization custom property.", + "description": "An organization custom property was deleted.", + "operationId": "organization-custom-property/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { @@ -104225,7 +103800,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-org-block-unblocked" + "$ref": "#/components/schemas/webhook-organization-custom-property-deleted" } } } @@ -104236,22 +103811,20 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "org_block", + "subcategory": "organization_custom_property", "supported-webhook-types": [ - "organization", - "business", - "app" + "business" ] } } }, - "organization-custom-property-created": { + "organization-custom-property-updated": { "post": { "summary": "This event occurs when there is activity relating to an organization custom property.", - "description": "A new organization custom property was created.", - "operationId": "organization-custom-property/created", + "description": "An organization custom property was updated.", + "operationId": "organization-custom-property/updated", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" }, @@ -104318,7 +103891,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-custom-property-created" + "$ref": "#/components/schemas/webhook-organization-custom-property-updated" } } } @@ -104338,13 +103911,13 @@ } } }, - "organization-custom-property-deleted": { + "organization-custom-property-values-updated": { "post": { - "summary": "This event occurs when there is activity relating to an organization custom property.", - "description": "An organization custom property was deleted.", - "operationId": "organization-custom-property/deleted", + "summary": "This event occurs when there is activity relating to custom property values for an organization.", + "description": "The custom property values of an organization were updated.", + "operationId": "organization-custom-property-values/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization-custom-property-values" }, "parameters": [ { @@ -104409,7 +103982,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-custom-property-deleted" + "$ref": "#/components/schemas/webhook-organization-custom-property-values-updated" } } } @@ -104422,20 +103995,22 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "organization_custom_property", + "subcategory": "organization-custom-property-values", "supported-webhook-types": [ - "business" + "business", + "organization", + "app" ] } } }, - "organization-custom-property-updated": { + "organization-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an organization custom property.", - "description": "An organization custom property was updated.", - "operationId": "organization-custom-property/updated", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization was deleted.", + "operationId": "organization/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization_custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -104500,7 +104075,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-custom-property-updated" + "$ref": "#/components/schemas/webhook-organization-deleted" } } } @@ -104511,22 +104086,24 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization_custom_property", + "subcategory": "organization", "supported-webhook-types": [ - "business" + "organization", + "business", + "app" ] } } }, - "organization-custom-property-values-updated": { + "organization-member-added": { "post": { - "summary": "This event occurs when there is activity relating to custom property values for an organization.", - "description": "The custom property values of an organization were updated.", - "operationId": "organization-custom-property-values/updated", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member accepted an invitation to join an organization.", + "operationId": "organization/member-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization-custom-property-values" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -104591,7 +104168,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-custom-property-values-updated" + "$ref": "#/components/schemas/webhook-organization-member-added" } } } @@ -104602,22 +104179,22 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization-custom-property-values", + "subcategory": "organization", "supported-webhook-types": [ - "business", "organization", + "business", "app" ] } } }, - "organization-deleted": { + "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/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization was deleted.", - "operationId": "organization/deleted", + "description": "A member was invited to join the organization.", + "operationId": "organization/member-invited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, @@ -104684,7 +104261,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-deleted" + "$ref": "#/components/schemas/webhook-organization-member-invited" } } } @@ -104706,11 +104283,11 @@ } } }, - "organization-member-added": { + "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/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member accepted an invitation to join an organization.", - "operationId": "organization/member-added", + "description": "A member was removed from the organization.", + "operationId": "organization/member-removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, @@ -104777,7 +104354,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-added" + "$ref": "#/components/schemas/webhook-organization-member-removed" } } } @@ -104799,11 +104376,11 @@ } } }, - "organization-member-invited": { + "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/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member was invited to join the organization.", - "operationId": "organization/member-invited", + "description": "The name of an organization was changed.", + "operationId": "organization/renamed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, @@ -104870,7 +104447,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-invited" + "$ref": "#/components/schemas/webhook-organization-renamed" } } } @@ -104892,13 +104469,13 @@ } } }, - "organization-member-removed": { + "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/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member was removed from the organization.", - "operationId": "organization/member-removed", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", + "description": "A package was published to a registry.", + "operationId": "package/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -104963,7 +104540,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-removed" + "$ref": "#/components/schemas/webhook-package-published" } } } @@ -104976,22 +104553,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "package", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "organization-renamed": { + "package-updated": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "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/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", + "description": "A previously published package was updated.", + "operationId": "package/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -105056,7 +104633,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-renamed" + "$ref": "#/components/schemas/webhook-package-updated" } } } @@ -105069,22 +104646,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "package", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "package-published": { + "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/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", - "description": "A package was published to a registry.", - "operationId": "package/published", + "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest//pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-cloud@latest//rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", + "operationId": "page-build", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#page_build" }, "parameters": [ { @@ -105149,7 +104725,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-published" + "$ref": "#/components/schemas/webhook-page-build" } } } @@ -105162,7 +104738,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "page_build", "supported-webhook-types": [ "repository", "organization", @@ -105171,13 +104747,13 @@ } } }, - "package-updated": { + "personal-access-token-request-approved": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", - "description": "A previously published package was updated.", - "operationId": "package/updated", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "description": "A fine-grained personal access token request was approved.", + "operationId": "personal-access-token-request/approved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -105189,9 +104765,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -105199,31 +104775,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -105242,7 +104818,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-updated" + "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" } } } @@ -105255,21 +104831,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", - "app" + "app", + "organization" ] } } }, - "page-build": { + "personal-access-token-request-cancelled": { "post": { - "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest//pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-cloud@latest//rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", - "operationId": "page-build", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "description": "A fine-grained personal access token request was cancelled by the requester.", + "operationId": "personal-access-token-request/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#page_build" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -105281,9 +104857,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -105291,31 +104867,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -105334,7 +104910,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-page-build" + "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" } } } @@ -105347,20 +104923,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/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was approved.", - "operationId": "personal-access-token-request/approved", + "description": "A fine-grained personal access token request was created.", + "operationId": "personal-access-token-request/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" }, @@ -105427,7 +105002,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" + "$ref": "#/components/schemas/webhook-personal-access-token-request-created" } } } @@ -105448,11 +105023,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/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was cancelled by the requester.", - "operationId": "personal-access-token-request/cancelled", + "description": "A fine-grained personal access token request was denied.", + "operationId": "personal-access-token-request/denied", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" }, @@ -105519,7 +105094,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" + "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" } } } @@ -105540,13 +105115,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/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was created.", - "operationId": "personal-access-token-request/created", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", + "operationId": "ping", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#ping" }, "parameters": [ { @@ -105558,9 +105132,9 @@ } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Id", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": 12312312, "schema": { "type": "string" } @@ -105568,31 +105142,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" } @@ -105611,7 +105185,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" + } } } } @@ -105623,22 +105212,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/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", - "description": "A fine-grained personal access token request was denied.", - "operationId": "personal-access-token-request/denied", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A note in a project (classic) was converted to an issue.", + "operationId": "project-card/converted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -105650,9 +105243,9 @@ } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Id", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": 12312312, "schema": { "type": "string" } @@ -105660,31 +105253,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" } @@ -105703,7 +105296,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" + "$ref": "#/components/schemas/webhook-project-card-converted" } } } @@ -105716,20 +105309,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/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card was added to a project (classic).", + "operationId": "project-card/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#ping" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -105794,22 +105389,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" } } } @@ -105821,24 +105401,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/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note in a project (classic) was converted to an issue.", - "operationId": "project-card/converted", + "description": "A card on a project (classic) was deleted.", + "operationId": "project-card/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, @@ -105905,7 +105482,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-converted" + "$ref": "#/components/schemas/webhook-project-card-deleted" } } } @@ -105927,11 +105504,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/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card was added to a project (classic).", - "operationId": "project-card/created", + "description": "A note on a project (classic) was edited.", + "operationId": "project-card/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, @@ -105998,7 +105575,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-created" + "$ref": "#/components/schemas/webhook-project-card-edited" } } } @@ -106020,11 +105597,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/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card on a project (classic) was deleted.", - "operationId": "project-card/deleted", + "description": "A card on a project (classic) was moved to another column or to another position in its column.", + "operationId": "project-card/moved", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, @@ -106091,7 +105668,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-deleted" + "$ref": "#/components/schemas/webhook-project-card-moved" } } } @@ -106113,13 +105690,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/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note on a project (classic) was edited.", - "operationId": "project-card/edited", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was closed.", + "operationId": "project/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -106184,7 +105761,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-edited" + "$ref": "#/components/schemas/webhook-project-closed" } } } @@ -106197,7 +105774,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "project", "supported-webhook-types": [ "repository", "organization", @@ -106206,13 +105783,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/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card on a project (classic) was moved to another column or to another position in its column.", - "operationId": "project-card/moved", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was added to a project (classic).", + "operationId": "project-column/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -106277,7 +105854,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-moved" + "$ref": "#/components/schemas/webhook-project-column-created" } } } @@ -106290,7 +105867,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "project_column", "supported-webhook-types": [ "repository", "organization", @@ -106299,13 +105876,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/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was closed.", - "operationId": "project/closed", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was deleted from a project (classic).", + "operationId": "project-column/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -106370,7 +105947,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-closed" + "$ref": "#/components/schemas/webhook-project-column-deleted" } } } @@ -106383,7 +105960,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_column", "supported-webhook-types": [ "repository", "organization", @@ -106392,11 +105969,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/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was added to a project (classic).", - "operationId": "project-column/created", + "description": "The name of a column on a project (classic) was changed.", + "operationId": "project-column/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" }, @@ -106463,7 +106040,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-created" + "$ref": "#/components/schemas/webhook-project-column-edited" } } } @@ -106485,11 +106062,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/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was deleted from a project (classic).", - "operationId": "project-column/deleted", + "description": "A column was moved to a new position on a project (classic).", + "operationId": "project-column/moved", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" }, @@ -106556,7 +106133,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-deleted" + "$ref": "#/components/schemas/webhook-project-column-moved" } } } @@ -106578,13 +106155,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/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "The name of a column on a project (classic) was changed.", - "operationId": "project-column/edited", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was created.", + "operationId": "project/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -106649,7 +106226,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-edited" + "$ref": "#/components/schemas/webhook-project-created" } } } @@ -106662,7 +106239,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "project", "supported-webhook-types": [ "repository", "organization", @@ -106671,13 +106248,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/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was moved to a new position on a project (classic).", - "operationId": "project-column/moved", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was deleted.", + "operationId": "project/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -106742,7 +106319,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-moved" + "$ref": "#/components/schemas/webhook-project-deleted" } } } @@ -106755,7 +106332,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "project", "supported-webhook-types": [ "repository", "organization", @@ -106764,11 +106341,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/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was created.", - "operationId": "project/created", + "description": "The name or description of a project (classic) was changed.", + "operationId": "project/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, @@ -106835,7 +106412,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-created" + "$ref": "#/components/schemas/webhook-project-edited" } } } @@ -106857,11 +106434,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/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was deleted.", - "operationId": "project/deleted", + "description": "A project (classic) was closed.", + "operationId": "project/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, @@ -106928,7 +106505,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-deleted" + "$ref": "#/components/schemas/webhook-project-reopened" } } } @@ -106950,13 +106527,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/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "The name or description of a project (classic) was changed.", - "operationId": "project/edited", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was closed.", + "operationId": "projects-v2/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -106978,7 +106555,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2", "schema": { "type": "string" } @@ -107021,7 +106598,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-edited" + "$ref": "#/components/schemas/webhook-projects-v2-project-closed" } } } @@ -107033,23 +106610,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/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was closed.", - "operationId": "project/reopened", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was created.", + "operationId": "projects-v2/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -107071,7 +106647,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2", "schema": { "type": "string" } @@ -107114,7 +106690,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-reopened" + "$ref": "#/components/schemas/webhook-projects-v2-project-created" } } } @@ -107126,21 +106702,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/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was closed.", - "operationId": "projects-v2/closed", + "description": "A project in the organization was deleted.", + "operationId": "projects-v2/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, @@ -107207,7 +106782,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-closed" + "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" } } } @@ -107228,11 +106803,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/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was created.", - "operationId": "projects-v2/created", + "description": "The title, description, or README of a project in the organization was changed.", + "operationId": "projects-v2/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, @@ -107299,7 +106874,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-created" + "$ref": "#/components/schemas/webhook-projects-v2-project-edited" } } } @@ -107320,13 +106895,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/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was deleted.", - "operationId": "projects-v2/deleted", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/archived", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -107348,7 +106923,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "project-v2-item", "schema": { "type": "string" } @@ -107391,7 +106966,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-item-archived" } } } @@ -107405,20 +106980,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/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The title, description, or README of a project in the organization was changed.", - "operationId": "projects-v2/edited", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A draft issue in an organization project was converted to an issue.", + "operationId": "projects-v2-item/converted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -107440,7 +107015,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "project-v2-item", "schema": { "type": "string" } @@ -107483,7 +107058,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-converted" } } } @@ -107497,18 +107072,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/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/archived", + "description": "An item was added to a project in the organization.", + "operationId": "projects-v2-item/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -107575,7 +107150,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-archived" + "$ref": "#/components/schemas/webhook-projects-v2-item-created" } } } @@ -107596,11 +107171,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/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A draft issue in an organization project was converted to an issue.", - "operationId": "projects-v2-item/converted", + "description": "An item was deleted from a project in the organization.", + "operationId": "projects-v2-item/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -107667,7 +107242,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-converted" + "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" } } } @@ -107688,11 +107263,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/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item was added to a project in the organization.", - "operationId": "projects-v2-item/created", + "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", + "operationId": "projects-v2-item/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -107759,7 +107334,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-created" + "$ref": "#/components/schemas/webhook-projects-v2-item-edited" } } } @@ -107780,11 +107355,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/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item was deleted from a project in the organization.", - "operationId": "projects-v2-item/deleted", + "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", + "operationId": "projects-v2-item/reordered", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -107851,7 +107426,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" } } } @@ -107872,11 +107447,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/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", - "operationId": "projects-v2-item/edited", + "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/restored", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -107943,7 +107518,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-restored" } } } @@ -107964,13 +107539,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/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", - "operationId": "projects-v2-item/reordered", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was reopened.", + "operationId": "projects-v2/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -107992,7 +107567,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "project-v2", "schema": { "type": "string" } @@ -108035,7 +107610,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" + "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" } } } @@ -108049,20 +107624,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/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/restored", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A status update was added to a project in the organization.", + "operationId": "projects-v2-status-update/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -108084,7 +107659,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "project-v2-status-update", "schema": { "type": "string" } @@ -108127,7 +107702,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-restored" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" } } } @@ -108141,20 +107716,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/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was reopened.", - "operationId": "projects-v2/reopened", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A status update was removed from a project in the organization.", + "operationId": "projects-v2-status-update/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -108176,7 +107751,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "project-v2-status-update", "schema": { "type": "string" } @@ -108219,7 +107794,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" } } } @@ -108233,18 +107808,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/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A status update was added to a project in the organization.", - "operationId": "projects-v2-status-update/created", + "description": "A status update was edited on a project in the organization.", + "operationId": "projects-v2-status-update/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" }, @@ -108311,7 +107886,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" } } } @@ -108332,13 +107907,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/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A status update was removed from a project in the organization.", - "operationId": "projects-v2-status-update/deleted", + "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "operationId": "public", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#public" }, "parameters": [ { @@ -108360,7 +107934,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-status-update", + "example": "issues", "schema": { "type": "string" } @@ -108403,7 +107977,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" + "$ref": "#/components/schemas/webhook-public" } } } @@ -108415,22 +107989,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/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A status update was edited on a project in the organization.", - "operationId": "projects-v2-status-update/edited", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was assigned to a user.", + "operationId": "pull-request/assigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -108452,7 +108027,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-status-update", + "example": "issues", "schema": { "type": "string" } @@ -108495,7 +108070,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" + "$ref": "#/components/schemas/webhook-pull-request-assigned" } } } @@ -108507,21 +108082,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/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "operationId": "public", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-disabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#public" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -108586,7 +108163,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-public" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" } } } @@ -108599,7 +108176,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "public", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -108608,11 +108185,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was assigned to a user.", - "operationId": "pull-request/assigned", + "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-enabled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -108679,7 +108256,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-assigned" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" } } } @@ -108701,11 +108278,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-disabled", + "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", + "operationId": "pull-request/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -108772,7 +108349,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" + "$ref": "#/components/schemas/webhook-pull-request-closed" } } } @@ -108794,11 +108371,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-enabled", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/converted-to-draft", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -108865,7 +108442,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" + "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" } } } @@ -108887,11 +108464,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", - "operationId": "pull-request/closed", + "description": "A pull request was removed from a milestone.", + "operationId": "pull-request/demilestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -108958,7 +108535,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-closed" + "$ref": "#/components/schemas/webhook-pull-request-demilestoned" } } } @@ -108980,11 +108557,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", - "operationId": "pull-request/converted-to-draft", + "description": "A pull request was removed from the merge queue.", + "operationId": "pull-request/dequeued", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -109051,7 +108628,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" + "$ref": "#/components/schemas/webhook-pull-request-dequeued" } } } @@ -109073,11 +108650,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was removed from a milestone.", - "operationId": "pull-request/demilestoned", + "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", + "operationId": "pull-request/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -109144,7 +108721,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-demilestoned" + "$ref": "#/components/schemas/webhook-pull-request-edited" } } } @@ -109166,11 +108743,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was removed from the merge queue.", - "operationId": "pull-request/dequeued", + "description": "A pull request was added to the merge queue.", + "operationId": "pull-request/enqueued", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -109237,7 +108814,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-dequeued" + "$ref": "#/components/schemas/webhook-pull-request-enqueued" } } } @@ -109259,11 +108836,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", - "operationId": "pull-request/edited", + "description": "A label was added to a pull request.", + "operationId": "pull-request/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -109330,7 +108907,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-edited" + "$ref": "#/components/schemas/webhook-pull-request-labeled" } } } @@ -109352,11 +108929,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was added to the merge queue.", - "operationId": "pull-request/enqueued", + "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -109423,7 +109000,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-enqueued" + "$ref": "#/components/schemas/webhook-pull-request-locked" } } } @@ -109445,11 +109022,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was added to a pull request.", - "operationId": "pull-request/labeled", + "description": "A pull request was added to a milestone.", + "operationId": "pull-request/milestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -109516,7 +109093,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-labeled" + "$ref": "#/components/schemas/webhook-pull-request-milestoned" } } } @@ -109538,11 +109115,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/locked", + "description": "A pull request was created", + "operationId": "pull-request/opened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -109609,7 +109186,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-locked" + "$ref": "#/components/schemas/webhook-pull-request-opened" } } } @@ -109631,11 +109208,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was added to a milestone.", - "operationId": "pull-request/milestoned", + "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/ready-for-review", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -109702,7 +109279,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-milestoned" + "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" } } } @@ -109724,11 +109301,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was created", - "operationId": "pull-request/opened", + "description": "A previously closed pull request was reopened.", + "operationId": "pull-request/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -109795,7 +109372,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-opened" + "$ref": "#/components/schemas/webhook-pull-request-reopened" } } } @@ -109817,13 +109394,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", - "operationId": "pull-request/ready-for-review", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was created.", + "operationId": "pull-request-review-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -109888,7 +109465,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" } } } @@ -109901,7 +109478,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -109910,13 +109487,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A previously closed pull request was reopened.", - "operationId": "pull-request/reopened", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was deleted.", + "operationId": "pull-request-review-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -109981,7 +109558,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-reopened" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" } } } @@ -109994,7 +109571,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -110003,11 +109580,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment on a pull request diff was created.", - "operationId": "pull-request-review-comment/created", + "description": "The content of a comment on a pull request diff was changed.", + "operationId": "pull-request-review-comment/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" }, @@ -110074,7 +109651,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" } } } @@ -110096,13 +109673,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment on a pull request diff was deleted.", - "operationId": "pull-request-review-comment/deleted", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was dismissed.", + "operationId": "pull-request-review/dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -110167,7 +109744,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" + "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" } } } @@ -110180,7 +109757,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -110189,13 +109766,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The content of a comment on a pull request diff was changed.", - "operationId": "pull-request-review-comment/edited", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The body comment on a pull request review was edited.", + "operationId": "pull-request-review/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -110260,7 +109837,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-edited" } } } @@ -110273,7 +109850,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -110282,13 +109859,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A review on a pull request was dismissed.", - "operationId": "pull-request-review/dismissed", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A request for review by a person or team was removed from a pull request.", + "operationId": "pull-request/review-request-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -110353,7 +109930,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" + "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" } } } @@ -110366,7 +109943,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -110375,11 +109952,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", + "operationId": "pull-request/review-requested", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The body comment on a pull request review was edited.", - "operationId": "pull-request-review/edited", + "description": "A review on a pull request was submitted.", + "operationId": "pull-request-review/submitted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" }, @@ -110446,7 +110116,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-submitted" } } } @@ -110468,106 +110138,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A request for review by a person or team was removed from a pull request.", - "operationId": "pull-request/review-request-removed", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", - "operationId": "pull-request/review-requested", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment thread on a pull request was marked as resolved.", + "operationId": "pull-request-review-thread/resolved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -110632,7 +110209,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-requested" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" } } } @@ -110645,7 +110222,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_thread", "supported-webhook-types": [ "repository", "organization", @@ -110654,13 +110231,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A review on a pull request was submitted.", - "operationId": "pull-request-review/submitted", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously resolved comment thread on a pull request was marked as unresolved.", + "operationId": "pull-request-review-thread/unresolved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -110725,7 +110302,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-submitted" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" } } } @@ -110738,7 +110315,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request_review_thread", "supported-webhook-types": [ "repository", "organization", @@ -110747,13 +110324,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment thread on a pull request was marked as resolved.", - "operationId": "pull-request-review-thread/resolved", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -110818,7 +110395,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" + "$ref": "#/components/schemas/webhook-pull-request-synchronize" } } } @@ -110831,7 +110408,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_thread", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -110840,13 +110417,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A previously resolved comment thread on a pull request was marked as unresolved.", - "operationId": "pull-request-review-thread/unresolved", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -110911,7 +110488,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" + "$ref": "#/components/schemas/webhook-pull-request-unassigned" } } } @@ -110924,7 +110501,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_thread", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -110933,11 +110510,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", - "operationId": "pull-request/synchronize", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -111004,7 +110581,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-synchronize" + "$ref": "#/components/schemas/webhook-pull-request-unlabeled" } } } @@ -111026,11 +110603,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A user was unassigned from a pull request.", - "operationId": "pull-request/unassigned", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -111097,7 +110674,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unassigned" + "$ref": "#/components/schemas/webhook-pull-request-unlocked" } } } @@ -111119,13 +110696,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was removed from a pull request.", - "operationId": "pull-request/unlabeled", + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -111190,7 +110766,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlabeled" + "$ref": "#/components/schemas/webhook-push" } } } @@ -111203,7 +110779,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "push", "supported-webhook-types": [ "repository", "organization", @@ -111212,13 +110788,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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package was published to a registry.", + "operationId": "registry-package/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -111283,7 +110859,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlocked" + "$ref": "#/components/schemas/webhook-registry-package-published" } } } @@ -111296,7 +110872,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -111305,12 +110881,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/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package that was previously published to a registry was updated.", + "operationId": "registry-package/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -111375,7 +110952,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-push" + "$ref": "#/components/schemas/webhook-registry-package-updated" } } } @@ -111388,7 +110965,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "push", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -111397,13 +110974,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/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package was published to a registry.", - "operationId": "registry-package/published", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", + "operationId": "release/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -111468,7 +111045,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-published" + "$ref": "#/components/schemas/webhook-release-created" } } } @@ -111481,7 +111058,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -111490,13 +111067,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/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", - "description": "A package that was previously published to a registry was updated.", - "operationId": "registry-package/updated", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release, pre-release, or draft release was deleted.", + "operationId": "release/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -111561,7 +111138,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-release-deleted" } } } @@ -111574,7 +111151,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -111583,11 +111160,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/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", - "operationId": "release/created", + "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "operationId": "release/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, @@ -111654,7 +111231,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-created" + "$ref": "#/components/schemas/webhook-release-edited" } } } @@ -111676,11 +111253,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/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release, pre-release, or draft release was deleted.", - "operationId": "release/deleted", + "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", + "operationId": "release/prereleased", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, @@ -111747,7 +111324,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-deleted" + "$ref": "#/components/schemas/webhook-release-prereleased" } } } @@ -111769,11 +111346,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/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", - "operationId": "release/edited", + "description": "A release, pre-release, or draft of a release was published.", + "operationId": "release/published", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, @@ -111840,7 +111417,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-edited" + "$ref": "#/components/schemas/webhook-release-published" } } } @@ -111862,11 +111439,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/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", - "operationId": "release/prereleased", + "description": "A release was published, or a pre-release was changed to a release.", + "operationId": "release/released", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, @@ -111933,7 +111510,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-release-released" } } } @@ -111955,11 +111532,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/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release, pre-release, or draft of a release was published.", - "operationId": "release/published", + "description": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, @@ -112026,7 +111603,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-release-unpublished" } } } @@ -112048,13 +111625,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/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release was published, or a pre-release was changed to a release.", - "operationId": "release/released", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A repository security advisory was published.", + "operationId": "repository-advisory/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -112119,7 +111696,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-repository-advisory-published" } } } @@ -112132,7 +111709,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "repository_advisory", "supported-webhook-types": [ "repository", "organization", @@ -112141,13 +111718,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/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release or pre-release was unpublished.", - "operationId": "release/unpublished", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A private vulnerability report was submitted.", + "operationId": "repository-advisory/reported", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -112212,7 +111789,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-repository-advisory-reported" } } } @@ -112225,7 +111802,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "repository_advisory", "supported-webhook-types": [ "repository", "organization", @@ -112234,13 +111811,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/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A repository security advisory was published.", - "operationId": "repository-advisory/published", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A repository was archived.", + "operationId": "repository/archived", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -112305,7 +111882,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-published" + "$ref": "#/components/schemas/webhook-repository-archived" } } } @@ -112318,8 +111895,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -112327,13 +111905,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/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A private vulnerability report was submitted.", - "operationId": "repository-advisory/reported", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A repository was created.", + "operationId": "repository/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -112398,7 +111976,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-reported" + "$ref": "#/components/schemas/webhook-repository-created" } } } @@ -112411,8 +111989,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -112420,11 +111999,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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was archived.", - "operationId": "repository/archived", + "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", + "operationId": "repository/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, @@ -112491,7 +112070,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-repository-deleted" } } } @@ -112514,13 +112093,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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was created.", - "operationId": "repository/created", + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "repository-dispatch/sample.collected", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch" }, "parameters": [ { @@ -112585,7 +112163,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-repository-dispatch-sample" } } } @@ -112598,21 +112176,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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", - "operationId": "repository/deleted", + "description": "The topics, default branch, description, or homepage of a repository was changed.", + "operationId": "repository/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, @@ -112679,7 +112254,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-repository-edited" } } } @@ -112702,12 +112277,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/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "repository-dispatch/sample.collected", + "summary": "This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest//get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports).", + "operationId": "repository-import", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_import" }, "parameters": [ { @@ -112772,7 +112347,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-repository-import" } } } @@ -112785,18 +112360,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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The topics, default branch, description, or homepage of a repository was changed.", - "operationId": "repository/edited", + "description": "The visibility of a repository was changed to `private`.", + "operationId": "repository/privatized", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, @@ -112863,7 +112439,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-repository-privatized" } } } @@ -112886,102 +112462,11 @@ } } }, - "repository-import": { - "post": { - "summary": "This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest//get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports).", - "operationId": "repository-import", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `private`.", - "operationId": "repository/privatized", + "description": "The visibility of a repository was changed to `public`.", + "operationId": "repository/publicized", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, @@ -113048,7 +112533,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-repository-publicized" } } } @@ -113071,11 +112556,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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `public`.", - "operationId": "repository/publicized", + "description": "The name of a repository was changed.", + "operationId": "repository/renamed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, @@ -113142,7 +112627,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-repository-renamed" } } } @@ -113165,13 +112650,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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The name of a repository was changed.", - "operationId": "repository/renamed", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was created.", + "operationId": "repository-ruleset/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -113236,7 +112721,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" } } } @@ -113249,9 +112734,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -113259,11 +112743,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/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was created.", - "operationId": "repository-ruleset/created", + "description": "A repository ruleset was deleted.", + "operationId": "repository-ruleset/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" }, @@ -113330,7 +112814,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" } } } @@ -113352,11 +112836,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/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was deleted.", - "operationId": "repository-ruleset/deleted", + "description": "A repository ruleset was edited.", + "operationId": "repository-ruleset/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" }, @@ -113423,7 +112907,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" } } } @@ -113445,13 +112929,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/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", - "description": "A repository ruleset was edited.", - "operationId": "repository-ruleset/edited", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -113516,7 +113000,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-transferred" } } } @@ -113529,8 +113013,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -113538,11 +113023,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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", - "operationId": "repository/transferred", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, @@ -113609,7 +113094,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-unarchived" } } } @@ -113632,13 +113117,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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -113703,7 +113188,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" } } } @@ -113716,21 +113201,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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -113797,7 +113280,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" } } } @@ -113818,11 +113301,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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -113889,7 +113372,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" } } } @@ -113910,11 +113393,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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -113981,7 +113464,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" } } } @@ -114002,13 +113485,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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -114073,7 +113556,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" } } } @@ -114086,10 +113569,11 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } @@ -114575,6 +114059,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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", @@ -119076,6 +118653,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.", @@ -121501,6 +121086,30 @@ "header_value" ] }, + "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", + "example": 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", + "example": 10 + } + } + }, "actions-cache-usage-org-enterprise": { "type": "object", "properties": { @@ -127554,6 +127163,35 @@ } } }, + "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.", + "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." + } + } + } + } + }, "enterprise-rules": { "title": "Repository Rule", "type": "object", @@ -127618,6 +127256,9 @@ }, { "$ref": "#/components/schemas/repository-rule-code-scanning" + }, + { + "$ref": "#/components/schemas/repository-rule-copilot-code-review" } ] }, @@ -127766,35 +127407,6 @@ } } }, - "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.", - "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." - } - } - } - } - }, "repository-rule-params-copilot-code-review-analysis-tool": { "title": "CopilotCodeReviewAnalysisTool", "description": "A tool that must provide code review results for this rule to pass.", @@ -128791,6 +128403,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": [ @@ -132613,6 +132229,30 @@ "updated_at" ] }, + "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", + "example": 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", + "example": 10 + } + } + }, "nullable-simple-repository": { "title": "Simple Repository", "description": "A GitHub repository.", @@ -137958,6 +137598,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", @@ -139290,6 +138994,9 @@ }, { "$ref": "#/components/schemas/repository-rule-code-scanning" + }, + { + "$ref": "#/components/schemas/repository-rule-copilot-code-review" } ] }, @@ -140612,96 +140319,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", - "nullable": true - }, - "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.", @@ -141209,156 +140826,6 @@ "updated_at" ] }, - "project-card": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" - }, - "id": { - "description": "The project card's ID", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" - }, - "note": { - "type": "string", - "example": "Add payload for delete Project column", - "nullable": true - }, - "creator": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "content_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - }, - "project-column": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - }, - "cards_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" - }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" - }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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": { - "$ref": "#/components/schemas/nullable-simple-user" - } - }, - "required": [ - "permission", - "user" - ] - }, "rate-limit": { "title": "Rate Limit", "type": "object", @@ -141538,6 +141005,30 @@ "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", + "example": 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", + "example": 10 + } + } + }, "actions-cache-list": { "title": "Repository actions caches", "description": "Repository actions caches", @@ -143599,6 +143090,7 @@ }, "date": { "type": "string", + "format": "date-time", "example": "\"2007-10-29T02:42:39.000-07:00\"" } }, @@ -153922,6 +153414,11 @@ "type": "string", "nullable": true }, + "secret-scanning-alert-assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true + }, "secret-scanning-location": { "type": "object", "properties": { @@ -173801,6 +173298,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -174604,6 +174108,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -288235,7 +287746,243 @@ "state": { "type": "string", "enum": [ - "dismissed" + "dismissed" + ] + } + } + }, + "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", + "sender" + ] + }, + "webhook-repository-vulnerability-alert-reopen": { + "title": "repository_vulnerability_alert reopen event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reopen" + ] + }, + "alert": { + "$ref": "#/components/schemas/webhooks_alert" + }, + "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", + "sender" + ] + }, + "webhook-repository-vulnerability-alert-resolve": { + "title": "repository_vulnerability_alert resolve event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "resolve" + ] + }, + "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", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "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", + "nullable": true, + "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": [ + "fixed", + "open" ] } } @@ -288263,218 +288010,21 @@ "sender" ] }, - "webhook-repository-vulnerability-alert-reopen": { - "title": "repository_vulnerability_alert reopen event", + "webhook-secret-scanning-alert-assigned": { + "title": "secret_scanning_alert assigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopen" + "assigned" ] }, "alert": { - "$ref": "#/components/schemas/webhooks_alert" - }, - "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" + "$ref": "#/components/schemas/secret-scanning-alert-webhook" }, - "sender": { + "assignee": { "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "action", - "alert", - "repository", - "sender" - ] - }, - "webhook-repository-vulnerability-alert-resolve": { - "title": "repository_vulnerability_alert resolve event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "resolve" - ] - }, - "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", - "nullable": true, - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": "string", - "nullable": true - }, - "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", - "nullable": true, - "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": [ - "fixed", - "open" - ] - } - } }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" @@ -288495,8 +288045,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] }, "webhook-secret-scanning-alert-created": { @@ -288688,6 +288237,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", @@ -301281,6 +300868,16 @@ } } }, + "actions-cache-retention-limit": { + "value": { + "max_cache_retention_days": 80 + } + }, + "actions-cache-storage-limit": { + "value": { + "max_cache_size_gb": 150 + } + }, "actions-cache-usage-org-enterprise": { "value": { "total_active_caches_size_in_bytes": 3344284, @@ -304167,7 +303764,22 @@ "update-budget": { "value": { "message": "Budget successfully updated.", - "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" + "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": { @@ -310148,6 +309760,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, @@ -310158,21 +309958,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", @@ -312602,94 +312420,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, @@ -312865,113 +312595,6 @@ } ] }, - "project-card": { - "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "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": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - }, - "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-card-items": { - "value": [ - { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "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": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - ] - }, - "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": { @@ -326084,7 +325707,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": { @@ -333505,6 +333148,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.", @@ -334546,15 +334212,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", @@ -334586,24 +334243,6 @@ ] } }, - "card-id": { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - "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/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index b38126a1f..fb58a86c6 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.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 @@ -1630,6 +1628,152 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: enterprises + "/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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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}/actions/cache/usage": get: summary: Get GitHub Actions cache usage for an enterprise @@ -8291,6 +8435,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/per-page" @@ -8506,6 +8651,24 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/budgets#get-all-budgets parameters: - "$ref": "#/components/parameters/enterprise" + - "$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" @@ -12323,6 +12486,152 @@ paths: category: orgs subcategory: custom-roles deprecated: true + "/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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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 @@ -25667,6 +25976,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/enterprise-cloud@latest//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 @@ -27266,6 +27707,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" @@ -29621,179 +30063,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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 - 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/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - nullable: true - 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/enterprise-cloud@latest//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/enterprise-cloud@latest//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 @@ -30152,825 +30421,6 @@ paths: deprecationDate: '2024-07-22' removalDate: '2025-07-22' deprecated: true - "/projects/columns/cards/{card_id}": - get: - summary: Get a project card - 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-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card - parameters: - - "$ref": "#/components/parameters/card-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-card" - examples: - default: - "$ref": "#/components/examples/project-card" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update an existing project card - 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-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card - parameters: - - "$ref": "#/components/parameters/card-id" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - note: - description: The project card's note - example: Update all gems - type: string - nullable: true - archived: - description: Whether or not the card is archived - example: false - type: boolean - examples: - default: - summary: Change the note on the card - value: - note: Add payload for delete Project column - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-card" - examples: - default: - "$ref": "#/components/examples/project-card" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete a project card - 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-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card - parameters: - - "$ref": "#/components/parameters/card-id" - responses: - '204': - description: Response - '304': - "$ref": "#/components/responses/not_modified" - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': - "$ref": "#/components/responses/requires_authentication" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/cards/{card_id}/moves": - post: - summary: Move a project card - 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-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card - parameters: - - "$ref": "#/components/parameters/card-id" - requestBody: - required: true - content: - application/json: - schema: - properties: - position: - description: 'The position of the card in a column. Can be one of: - `top`, `bottom`, or `after:` to place after the specified - card.' - example: bottom - type: string - pattern: "^(?:top|bottom|after:\\d+)$" - column_id: - description: The unique identifier of the column the card should - be moved to - example: 42 - type: integer - required: - - position - type: object - examples: - default: - summary: Move the card to the bottom of the column - value: - column_id: 42 - position: bottom - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': - "$ref": "#/components/responses/not_modified" - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: object - properties: - code: - type: string - message: - type: string - resource: - type: string - field: - type: string - '401': - "$ref": "#/components/responses/requires_authentication" - '503': - description: Response - content: - application/json: - schema: - type: object - properties: - code: - type: string - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: object - properties: - code: - type: string - message: - type: string - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - 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/enterprise-cloud@latest//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/enterprise-cloud@latest//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 - example: Remaining tasks - type: string - 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/enterprise-cloud@latest//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}/cards": - get: - summary: List project cards - 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-cards - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards - parameters: - - "$ref": "#/components/parameters/column-id" - - name: archived_state - description: Filters the project cards that are returned by the card's state. - in: query - required: false - schema: - type: string - enum: - - all - - archived - - not_archived - default: not_archived - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/project-card" - examples: - default: - "$ref": "#/components/examples/project-card-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: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create a project card - 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/create-card - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card - parameters: - - "$ref": "#/components/parameters/column-id" - requestBody: - required: true - content: - application/json: - schema: - oneOf: - - type: object - properties: - note: - description: The project card's note - example: Update all gems - type: string - nullable: true - required: - - note - - type: object - properties: - content_id: - description: The unique identifier of the content associated with - the card - example: 42 - type: integer - content_type: - description: The piece of content associated with the card - example: PullRequest - type: string - required: - - content_id - - content_type - examples: - default: - summary: Create a new card - value: - note: Add payload for delete Project column - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-card" - examples: - default: - "$ref": "#/components/examples/project-card" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - '422': - description: Validation failed - content: - application/json: - schema: - oneOf: - - "$ref": "#/components/schemas/validation-error" - - "$ref": "#/components/schemas/validation-error-simple" - '503': - description: Response - content: - application/json: - schema: - type: object - properties: - code: - type: string - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: object - properties: - code: - type: string - message: - type: string - x-github: - githubCloudOnly: true - enabledForGitHubApps: true - category: projects-classic - subcategory: cards - 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/enterprise-cloud@latest//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.' - example: last - type: string - pattern: "^(?:first|last|after:\\d+)$" - 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/enterprise-cloud@latest//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/enterprise-cloud@latest//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 - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - example: write - type: string - nullable: true - 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/enterprise-cloud@latest//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/enterprise-cloud@latest//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 @@ -31544,6 +30994,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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 @@ -54241,6 +53841,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" @@ -54320,6 +53921,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. @@ -54346,14 +53949,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 @@ -54371,7 +53986,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: @@ -59214,184 +58830,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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//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) @@ -65489,6 +64927,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/enterprise-cloud@latest//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 @@ -78812,7 +78374,74 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-dequeued" + "$ref": "#/components/schemas/webhook-pull-request-dequeued" + 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-edited: + post: + summary: |- + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + + For 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. + + To 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 + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//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-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -78825,7 +78454,7 @@ x-webhooks: - repository - organization - app - pull-request-edited: + pull-request-enqueued: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. @@ -78833,9 +78462,8 @@ x-webhooks: For 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. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: The title or body of a pull request was edited, or the base branch - of a pull request was changed. - operationId: pull-request/edited + description: A pull request was added to the merge queue. + operationId: pull-request/enqueued externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: @@ -78879,7 +78507,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-edited" + "$ref": "#/components/schemas/webhook-pull-request-enqueued" responses: '200': description: Return a 200 status to indicate that the data was received @@ -78892,7 +78520,7 @@ x-webhooks: - repository - organization - app - pull-request-enqueued: + pull-request-labeled: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. @@ -78900,8 +78528,8 @@ x-webhooks: For 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. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was added to the merge queue. - operationId: pull-request/enqueued + description: A label was added to a pull request. + operationId: pull-request/labeled externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: @@ -78945,7 +78573,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-enqueued" + "$ref": "#/components/schemas/webhook-pull-request-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -78958,7 +78586,7 @@ x-webhooks: - repository - organization - app - pull-request-labeled: + pull-request-locked: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. @@ -78966,8 +78594,9 @@ x-webhooks: For 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. To 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: Conversation on a pull request was locked. For more information, + see "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/locked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: @@ -79011,7 +78640,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-labeled" + "$ref": "#/components/schemas/webhook-pull-request-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79024,7 +78653,7 @@ x-webhooks: - repository - organization - app - pull-request-locked: + 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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. @@ -79032,9 +78661,8 @@ x-webhooks: For 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. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Conversation on a pull request was locked. For more information, - see "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." - operationId: pull-request/locked + description: A pull request was added to a milestone. + operationId: pull-request/milestoned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: @@ -79078,7 +78706,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-locked" + "$ref": "#/components/schemas/webhook-pull-request-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79091,7 +78719,7 @@ x-webhooks: - repository - organization - app - pull-request-milestoned: + 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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. @@ -79099,8 +78727,8 @@ x-webhooks: For 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. To 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 pull request was created + operationId: pull-request/opened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: @@ -79144,7 +78772,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-milestoned" + "$ref": "#/components/schemas/webhook-pull-request-opened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79157,7 +78785,7 @@ x-webhooks: - repository - organization - app - pull-request-opened: + 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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. @@ -79165,8 +78793,9 @@ x-webhooks: For 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. To 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 draft pull request was marked as ready for review. For more information, + see "[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." + operationId: pull-request/ready-for-review externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: @@ -79210,7 +78839,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-opened" + "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79223,7 +78852,7 @@ x-webhooks: - repository - organization - app - pull-request-ready-for-review: + 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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. @@ -79231,9 +78860,8 @@ x-webhooks: For 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. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A draft pull request was marked as ready for review. For more information, - see "[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." - operationId: pull-request/ready-for-review + description: A previously closed pull request was reopened. + operationId: pull-request/reopened externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: @@ -79277,7 +78905,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" + "$ref": "#/components/schemas/webhook-pull-request-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79290,18 +78918,18 @@ x-webhooks: - repository - organization - app - pull-request-reopened: + 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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. - For 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. + For 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. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A previously closed pull request was reopened. - operationId: pull-request/reopened + description: A comment on a pull request diff was created. + operationId: pull-request-review-comment/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -79343,7 +78971,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-reopened" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79351,12 +78979,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app - pull-request-review-comment-created: + pull-request-review-comment-deleted: post: summary: |- This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. @@ -79364,8 +78992,8 @@ x-webhooks: For 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. To 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: A comment on a pull request diff was deleted. + operationId: pull-request-review-comment/deleted externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: @@ -79409,7 +79037,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79422,7 +79050,7 @@ x-webhooks: - repository - organization - app - pull-request-review-comment-deleted: + 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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. @@ -79430,8 +79058,8 @@ x-webhooks: For 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. To 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 + description: The content of a comment on a pull request diff was changed. + operationId: pull-request-review-comment/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: @@ -79475,7 +79103,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79488,18 +79116,18 @@ x-webhooks: - repository - organization - app - pull-request-review-comment-edited: + 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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)" in the REST API documentation. - For 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. + For 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. To 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 + description: A review on a pull request was dismissed. + operationId: pull-request-review/dismissed externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header @@ -79541,7 +79169,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79549,12 +79177,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_comment + subcategory: pull_request_review supported-webhook-types: - repository - organization - app - pull-request-review-dismissed: + pull-request-review-edited: post: summary: |- This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)" in the REST API documentation. @@ -79562,8 +79190,8 @@ x-webhooks: For 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. To 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 + description: The body comment on a pull request review was edited. + operationId: pull-request-review/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review parameters: @@ -79607,7 +79235,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" + "$ref": "#/components/schemas/webhook-pull-request-review-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79620,7 +79248,141 @@ x-webhooks: - repository - organization - app - pull-request-review-edited: + pull-request-review-request-removed: + post: + summary: |- + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + + For 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. + + To 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/enterprise-cloud@latest//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: + post: + summary: |- + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + + For 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. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: Review by a person or team was requested for a pull request. For + more information, see "[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." + operationId: pull-request/review-requested + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)" in the REST API documentation. @@ -79628,8 +79390,8 @@ x-webhooks: For 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. To 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review parameters: @@ -79673,7 +79435,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-submitted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79686,86 +79448,18 @@ x-webhooks: - repository - organization - app - pull-request-review-request-removed: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. - - For 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. - - To 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/enterprise-cloud@latest//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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. - For 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. + For 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. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Review by a person or team was requested for a pull request. For - more information, see "[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." - operationId: pull-request/review-requested + description: A comment thread on a pull request was marked as resolved. + operationId: pull-request-review-thread/resolved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header @@ -79807,7 +79501,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-requested" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79815,23 +79509,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review_thread supported-webhook-types: - repository - organization - app - 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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. - For 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. + For 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. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A review on a pull request was submitted. - operationId: pull-request-review/submitted + description: A previously resolved comment thread on a pull request was marked + as unresolved. + operationId: pull-request-review-thread/unresolved externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header @@ -79873,7 +79568,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-submitted" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79881,23 +79576,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review + subcategory: pull_request_review_thread supported-webhook-types: - repository - organization - app - 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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. - For 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. + For 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. To 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 + description: A pull request's head branch was updated. For example, the head + branch was updated from the base branch or new commits were pushed to the + head branch. + operationId: pull-request/synchronize externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -79939,7 +79636,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" + "$ref": "#/components/schemas/webhook-pull-request-synchronize" responses: '200': description: Return a 200 status to indicate that the data was received @@ -79947,24 +79644,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_thread + subcategory: pull_request supported-webhook-types: - repository - organization - app - 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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. - For 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. + For 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. To 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 + description: A user was unassigned from a pull request. + operationId: pull-request/unassigned externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -80006,7 +79702,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" + "$ref": "#/components/schemas/webhook-pull-request-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80014,12 +79710,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_thread + subcategory: pull_request supported-webhook-types: - repository - organization - app - 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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. @@ -80027,10 +79723,8 @@ x-webhooks: For 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. To 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: @@ -80074,7 +79768,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-synchronize" + "$ref": "#/components/schemas/webhook-pull-request-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80087,7 +79781,7 @@ x-webhooks: - repository - organization - app - 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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. @@ -80095,8 +79789,9 @@ x-webhooks: For 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. To 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/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/unlocked externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request parameters: @@ -80140,7 +79835,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-unassigned" + "$ref": "#/components/schemas/webhook-pull-request-unlocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80153,18 +79848,20 @@ x-webhooks: - repository - organization - app - 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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + 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, + when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch + and tag deletions, use the [`delete`](#delete) webhook event. - For 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. + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A label was removed from a pull request. - operationId: pull-request/unlabeled + > [!NOTE] + > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. + operationId: push externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#push parameters: - name: User-Agent in: header @@ -80206,7 +79903,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-unlabeled" + "$ref": "#/components/schemas/webhook-push" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80214,24 +79911,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: push supported-webhook-types: - repository - organization - app - 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/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)" in the REST API documentation. - For 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. + To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Conversation on a pull request was unlocked. For more information, - see "[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations)." - operationId: pull-request/unlocked + > [!NOTE] + > GitHub recommends that you use the newer `package` event instead. + description: A package was published to a registry. + operationId: registry-package/published externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package parameters: - name: User-Agent in: header @@ -80273,7 +79970,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-unlocked" + "$ref": "#/components/schemas/webhook-registry-package-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80281,25 +79978,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: registry_package supported-webhook-types: - repository - organization - app - 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, - when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch - and tag deletions, use the [`delete`](#delete) webhook event. + This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. > [!NOTE] - > 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 + > GitHub recommends that you use the newer `package` event instead. + description: A package that was previously published to a registry was updated. + operationId: registry-package/updated externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#push + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package parameters: - name: User-Agent in: header @@ -80341,7 +80037,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-push" + "$ref": "#/components/schemas/webhook-registry-package-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80349,24 +80045,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: push + subcategory: registry_package supported-webhook-types: - repository - organization - app - 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/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)" in the REST API documentation. - - To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. - > [!NOTE] - > GitHub recommends that you use the newer `package` event instead. - description: A package was published to a registry. - operationId: registry-package/published + To 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -80408,7 +80102,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-registry-package-published" + "$ref": "#/components/schemas/webhook-release-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80416,24 +80110,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: registry_package + subcategory: release supported-webhook-types: - repository - organization - app - 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/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)" in the REST API documentation. - - To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. - > [!NOTE] - > 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 + To 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -80475,7 +80166,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-release-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80483,20 +80174,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: registry_package + subcategory: release supported-webhook-types: - repository - organization - app - 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/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. To 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/enterprise-cloud@latest//repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." + operationId: release/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release parameters: @@ -80540,7 +80231,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-created" + "$ref": "#/components/schemas/webhook-release-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80553,14 +80244,15 @@ x-webhooks: - repository - organization - app - 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/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. To 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release parameters: @@ -80604,7 +80296,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-deleted" + "$ref": "#/components/schemas/webhook-release-prereleased" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80617,15 +80309,14 @@ x-webhooks: - repository - organization - app - 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/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: The details of a release, pre-release, or draft release were edited. - For more information, see "[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." - operationId: release/edited + description: A release, pre-release, or draft of a release was published. + operationId: release/published externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release parameters: @@ -80669,7 +80360,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-edited" + "$ref": "#/components/schemas/webhook-release-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80682,15 +80373,14 @@ x-webhooks: - repository - organization - app - 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/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. To 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release parameters: @@ -80734,7 +80424,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-release-released" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80747,14 +80437,14 @@ x-webhooks: - repository - organization - app - 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/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. To 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release parameters: @@ -80798,7 +80488,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-release-unpublished" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80811,16 +80501,16 @@ x-webhooks: - repository - organization - app - 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/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." - To 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. + description: A repository security advisory was published. + operationId: repository-advisory/published externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory parameters: - name: User-Agent in: header @@ -80862,7 +80552,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-repository-advisory-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80870,21 +80560,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: release + subcategory: repository_advisory supported-webhook-types: - repository - organization - app - 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/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." - To 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. + description: A private vulnerability report was submitted. + operationId: repository-advisory/reported externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory parameters: - name: User-Agent in: header @@ -80926,7 +80616,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-repository-advisory-reported" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80934,21 +80624,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: release + subcategory: repository_advisory supported-webhook-types: - repository - organization - app - 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/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. - To 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 + To 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -80990,7 +80680,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-advisory-published" + "$ref": "#/components/schemas/webhook-repository-archived" responses: '200': description: Return a 200 status to indicate that the data was received @@ -80998,21 +80688,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_advisory + subcategory: repository supported-webhook-types: + - business - repository - organization - app - 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/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. - To 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A repository was created. + operationId: repository/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -81054,7 +80745,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-advisory-reported" + "$ref": "#/components/schemas/webhook-repository-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81062,19 +80753,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_advisory + subcategory: repository supported-webhook-types: + - business - repository - organization - app - 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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. To 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository parameters: @@ -81118,7 +80811,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-repository-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81132,16 +80825,15 @@ x-webhooks: - repository - organization - app - 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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - To 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + operationId: repository-dispatch/sample.collected externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch parameters: - name: User-Agent in: header @@ -81183,7 +80875,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-repository-dispatch-sample" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81191,21 +80883,18 @@ x-webhooks: 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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. To 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository parameters: @@ -81249,7 +80938,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-repository-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81263,15 +80952,14 @@ x-webhooks: - repository - organization - app - 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/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - - To 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 Enterprise + Cloud. For more information, see "[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest//get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer)." + For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports). + operationId: repository-import externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_import parameters: - name: User-Agent in: header @@ -81313,7 +81001,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-repository-import" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81321,18 +81009,18 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_dispatch + subcategory: repository_import supported-webhook-types: - - app - repository-edited: + - repository + - organization + repository-privatized: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. To 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository parameters: @@ -81376,7 +81064,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-repository-privatized" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81390,14 +81078,16 @@ x-webhooks: - repository - organization - app - repository-import: + repository-publicized: post: - summary: This event occurs when a repository is imported to GitHub Enterprise - Cloud. For more information, see "[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest//get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer)." - For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports). - operationId: repository-import + summary: |- + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: The visibility of a repository was changed to `public`. + operationId: repository/publicized externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_import + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -81439,7 +81129,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-import" + "$ref": "#/components/schemas/webhook-repository-publicized" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81447,18 +81137,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_import + subcategory: repository supported-webhook-types: + - business - repository - organization - repository-privatized: + - app + repository-renamed: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. To 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 name of a repository was changed. + operationId: repository/renamed externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository parameters: @@ -81502,7 +81194,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-repository-renamed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81516,16 +81208,18 @@ x-webhooks: - repository - organization - app - repository-publicized: + 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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repository rulesets. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation." - To 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 + To 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header @@ -81567,7 +81261,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81575,22 +81269,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: repository_ruleset supported-webhook-types: - - business - repository - organization - app - repository-renamed: + repository-ruleset-deleted: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to repository rulesets. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation." - To 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. + description: A repository ruleset was deleted. + operationId: repository-ruleset/deleted externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header @@ -81632,7 +81327,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81640,13 +81335,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: repository_ruleset supported-webhook-types: - - business - repository - organization - app - repository-ruleset-created: + repository-ruleset-edited: post: summary: |- This event occurs when there is activity relating to repository rulesets. @@ -81654,8 +81348,8 @@ x-webhooks: For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation." To 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 edited. + operationId: repository-ruleset/edited externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset parameters: @@ -81699,7 +81393,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81712,18 +81406,20 @@ x-webhooks: - repository - organization - app - repository-ruleset-deleted: + repository-transferred: post: summary: |- - This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation." + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. - To 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Ownership of the repository was transferred to a user or organization + account. This event is only sent to the account where the ownership is transferred. + To receive the `repository.transferred` event, the new owner account must + have the GitHub App installed, and the App must be subscribed to "Repository" + events. + operationId: repository/transferred externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -81765,7 +81461,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81773,23 +81469,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_ruleset + subcategory: repository supported-webhook-types: + - business - repository - organization - app - repository-ruleset-edited: + repository-unarchived: post: summary: |- - This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation." + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. - To 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A previously archived repository was unarchived. + operationId: repository/unarchived externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -81831,7 +81526,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-unarchived" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81839,25 +81534,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_ruleset + subcategory: repository supported-webhook-types: + - business - repository - organization - app - 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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to a security vulnerability alert in a repository. - To 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 + > [!WARNING] + > **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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -81899,7 +81592,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81907,22 +81600,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: repository_vulnerability_alert supported-webhook-types: - - business - repository - organization - - app - 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/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to a security vulnerability alert in a repository. - To 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 + > [!WARNING] + > **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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -81964,7 +81656,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" responses: '200': description: Return a 200 status to indicate that the data was received @@ -81972,21 +81664,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: repository_vulnerability_alert supported-webhook-types: - - business - repository - organization - - app - 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. > [!WARNING] > **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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: @@ -82030,7 +81721,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" responses: '200': description: Return a 200 status to indicate that the data was received @@ -82042,15 +81733,15 @@ x-webhooks: supported-webhook-types: - repository - organization - 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. > [!WARNING] > **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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: @@ -82094,7 +81785,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" responses: '200': description: Return a 200 status to indicate that the data was received @@ -82106,18 +81797,18 @@ x-webhooks: supported-webhook-types: - repository - organization - repository-vulnerability-alert-reopen: + secret-scanning-alert-assigned: post: summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. - > [!WARNING] - > **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 + 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -82159,7 +81850,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -82167,21 +81858,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_vulnerability_alert + subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - repository-vulnerability-alert-resolve: + - app + secret-scanning-alert-created: post: summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. - > [!WARNING] - > **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 + 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -82223,7 +81916,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -82231,22 +81924,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_vulnerability_alert + subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - secret-scanning-alert-created: + - app + secret-scanning-alert-location-created: post: summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to the locations of a secret in a secret scanning alert. - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alerts, use the `secret_scanning_alert` 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 new instance of a previously detected secret was detected in + a repository, and the location of the secret was added to the existing alert. + operationId: secret-scanning-alert-location/created externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location parameters: - name: User-Agent in: header @@ -82288,34 +81985,41 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" + examples: + default: + "$ref": "#/components/examples/secret-scanning-alert-location-created" + application/x-www-form-urlencoded: + schema: + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" + examples: + default: + "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: secret_scanning_alert + subcategory: secret_scanning_alert_location supported-webhook-types: - repository - organization - app - 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. - - For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. - For activity relating to secret scanning alerts, use the `secret_scanning_alert` event. + 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 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 + description: A secret scanning alert was detected in a public repo. + operationId: secret-scanning-alert/publicly-leaked externalDocs: - url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -82357,30 +82061,20 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" - examples: - default: - "$ref": "#/components/examples/secret-scanning-alert-location-created" - application/x-www-form-urlencoded: - schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" - examples: - default: - "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: secret_scanning_alert_location + subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app - 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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. @@ -82388,8 +82082,8 @@ x-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 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -82433,7 +82127,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -82446,7 +82140,7 @@ x-webhooks: - repository - organization - app - 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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. @@ -82454,8 +82148,8 @@ x-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 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/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -82499,7 +82193,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -82512,7 +82206,7 @@ x-webhooks: - repository - organization - app - 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/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)" in the REST API documentation. @@ -82520,8 +82214,8 @@ x-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 closed. - operationId: secret-scanning-alert/resolved + description: A secret scanning alert was unassigned. + operationId: secret-scanning-alert/unassigned externalDocs: url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -82565,7 +82259,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -85866,6 +85560,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 @@ -87881,6 +87582,26 @@ components: - message - header_name - header_value + 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 + example: 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 + example: 10 actions-cache-usage-org-enterprise: type: object properties: @@ -92692,6 +92413,29 @@ components: "$ref": "#/components/schemas/repository-rule-params-code-scanning-tool" required: - code_scanning_tools + 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. + 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. enterprise-rules: title: Repository Rule type: object @@ -92717,6 +92461,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" repository-ruleset-conditions-repository-id-target: title: Repository ruleset conditions for repository IDs type: object @@ -92832,29 +92577,6 @@ components: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - 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. - 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. repository-rule-params-copilot-code-review-analysis-tool: title: CopilotCodeReviewAnalysisTool description: A tool that must provide code review results for this rule to pass. @@ -93603,6 +93325,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 create-budget: @@ -96505,6 +96231,26 @@ components: - organization - created_at - updated_at + 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 + example: 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 + example: 10 nullable-simple-repository: title: Simple Repository description: A GitHub repository. @@ -100838,6 +100584,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 @@ -101913,6 +101708,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 @@ -102965,74 +102761,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 - nullable: true - 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. @@ -103441,124 +103169,6 @@ components: - watchers_count - created_at - updated_at - project-card: - title: Project Card - description: Project cards represent a scope of work. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/cards/1478 - id: - description: The project card's ID - example: 42 - type: integer - format: int64 - node_id: - type: string - example: MDExOlByb2plY3RDYXJkMTQ3OA== - note: - type: string - example: Add payload for delete Project column - nullable: true - creator: - "$ref": "#/components/schemas/nullable-simple-user" - created_at: - type: string - format: date-time - example: '2016-09-05T14:21:06Z' - updated_at: - type: string - format: date-time - example: '2016-09-05T14:20:22Z' - archived: - description: Whether or not the card is archived - example: false - type: boolean - column_name: - type: string - project_id: - type: string - column_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - content_url: - type: string - format: uri - example: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - required: - - id - - node_id - - note - - url - - column_url - - project_url - - creator - - created_at - - updated_at - project-column: - title: Project Column - description: Project columns contain cards of work. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - cards_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - example: 42 - type: integer - node_id: - type: string - example: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - example: Remaining tasks - type: string - created_at: - type: string - format: date-time - example: '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - example: '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: - "$ref": "#/components/schemas/nullable-simple-user" - required: - - permission - - user rate-limit: title: Rate Limit type: object @@ -103693,6 +103303,24 @@ 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 + example: 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 + example: 10 actions-cache-list: title: Repository actions caches description: Repository actions caches @@ -105266,6 +104894,7 @@ components: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true verification: @@ -113083,6 +112712,11 @@ components: be updated or deleted. type: string nullable: true + secret-scanning-alert-assignee: + description: The username of the user to assign to the alert. Set to `null` + to unassign the alert. + type: string + nullable: true secret-scanning-location: type: object properties: @@ -128207,6 +127841,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -128820,6 +128459,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -214556,6 +214200,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 @@ -214687,6 +214357,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 @@ -224795,6 +224491,12 @@ components: "$ref": server-statistics-packages.yaml advisory_db_stats: "$ref": server-statistics-advisory-db.yaml + actions-cache-retention-limit: + value: + max_cache_retention_days: 80 + actions-cache-storage-limit: + value: + max_cache_size_gb: 150 actions-cache-usage-org-enterprise: value: total_active_caches_size_in_bytes: 3344284 @@ -227028,7 +226730,19 @@ components: update-budget: value: message: Budget successfully updated. - budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b + 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. @@ -232138,6 +231852,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 @@ -232147,17 +231993,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: @@ -234261,84 +234119,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 @@ -234496,100 +234276,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-card: - value: - url: https://api.github.com/projects/columns/cards/1478 - id: 1478 - node_id: MDExOlByb2plY3RDYXJkMTQ3OA== - note: Add payload for delete Project column - 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: '2016-09-05T14:21:06Z' - updated_at: '2016-09-05T14:20:22Z' - archived: false - column_url: https://api.github.com/projects/columns/367 - content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: https://api.github.com/projects/120 - 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-card-items: - value: - - url: https://api.github.com/projects/columns/cards/1478 - id: 1478 - node_id: MDExOlByb2plY3RDYXJkMTQ3OA== - note: Add payload for delete Project column - 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: '2016-09-05T14:21:06Z' - updated_at: '2016-09-05T14:20:22Z' - archived: false - column_url: https://api.github.com/projects/columns/367 - content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: https://api.github.com/projects/120 - 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: @@ -245854,6 +245540,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 @@ -252267,6 +251972,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 @@ -253171,13 +252895,6 @@ components: required: true schema: type: integer - project-id: - name: project_id - description: The unique identifier of the project. - in: path - required: tr{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}