diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 94467be58..a0db7a66d 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -7674,6 +7674,387 @@ } } }, + "/organizations/{org}/settings/billing/budgets": { + "get": { + "summary": "Get all budgets for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all budgets for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-all-budgets-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-all-budgets-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/get_all_budgets" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, + "/organizations/{org}/settings/billing/budgets/{budget_id}": { + "get": { + "summary": "Get a budget by ID for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a budget by ID. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-a-budget-by-id-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/budget" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/budget" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "patch": { + "summary": "Update a budget for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nUpdates an existing budget for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/update-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/budget" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + }, + "examples": { + "update-budget": { + "summary": "Update budget example", + "value": { + "prevent_further_usage": false, + "budget_amount": 10, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Budget updated successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": [ + "Budget successfully updated." + ] + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "required": [ + "will_alert", + "alert_recipients" + ], + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "default": "" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + } + } + }, + "examples": { + "update-budget": { + "value": { + "message": "Budget successfully updated.", + "id": "550e8400-e29b-41d4-a716-446655440000" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "description": "Budget not found or feature not enabled", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "budget-not-found": { + "value": { + "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget" + } + }, + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget" + } + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to update budget.", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "delete": { + "summary": "Delete a budget for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/delete-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/enhanced-billing#delete-a-budget-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/budget" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/delete-budget" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", @@ -7790,7 +8171,7 @@ }, "/organizations/{org}/settings/billing/usage/summary": { "get": { - "summary": "Get billing usage summary report for an organization", + "summary": "Get billing usage summary for an organization", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" @@ -7798,7 +8179,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-report-for-an-organization" + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-for-an-organization" }, "parameters": [ { @@ -23466,172 +23847,6 @@ } } }, - "/orgs/{org}/projects": { - "get": { - "summary": "List organization 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#list-organization-projects" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/project" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create an organization 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#create-an-organization-project" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the project." - }, - "body": { - "type": "string", - "description": "The description of the project." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-2" - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "410": { - "$ref": "#/components/responses/gone" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/orgs/{org}/projectsV2": { "get": { "summary": "List projects for organization", @@ -30042,21 +30257,42 @@ "deprecated": true } }, - "/projects/{project_id}": { + "/projects/{project_id}/collaborators": { "get": { - "summary": "Get a project", + "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/get", + "operationId": "projects-classic/list-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#get-a-project" + "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": { @@ -30065,16 +30301,30 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/project" + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } }, "examples": { "default": { - "$ref": "#/components/examples/project-3" + "$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" }, @@ -30089,26 +30339,31 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects-classic", - "subcategory": "projects", + "subcategory": "collaborators", "deprecationDate": "2024-05-23", "removalDate": "2025-04-01" }, "deprecated": true - }, - "patch": { - "summary": "Update a project", + } + }, + "/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.", - "operationId": "projects-classic/update", "tags": [ "projects-classic" ], + "operationId": "projects-classic/add-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#update-a-project" + "url": "https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator" }, "parameters": [ { "$ref": "#/components/parameters/project-id" + }, + { + "$ref": "#/components/parameters/username" } ], "requestBody": { @@ -30116,55 +30371,31 @@ "content": { "application/json": { "schema": { + "type": [ + "object", + "null" + ], "properties": { - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project", - "type": "string", + "permission": { + "description": "The permission to grant the collaborator.", "enum": [ "read", "write", - "admin", - "none" + "admin" + ], + "default": "write", + "type": "string", + "examples": [ + "write" ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone.", - "type": "boolean" } - }, - "type": "object" + } }, "examples": { "default": { - "summary": "Change the name, state, and permissions for a project", + "summary": "Applying write permissions for the new collaborator", "value": { - "name": "Week One Sprint", - "state": "open", - "organization_permission": "write" + "permission": "write" } } } @@ -30172,175 +30403,103 @@ } }, "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-3" - } - } - } - } + "204": { + "description": "Response" }, "404": { - "description": "Not Found if the authenticated user does not have access to the project" + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" }, "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" - } - } - } - } - } - } + "$ref": "#/components/responses/forbidden" }, "401": { "$ref": "#/components/responses/requires_authentication" - }, - "410": { - "$ref": "#/components/responses/gone" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects-classic", - "subcategory": "projects", + "subcategory": "collaborators", "deprecationDate": "2024-05-23", "removalDate": "2025-04-01" }, "deprecated": true }, "delete": { - "summary": "Delete a project", + "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.", - "operationId": "projects-classic/delete", "tags": [ "projects-classic" ], + "operationId": "projects-classic/remove-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#delete-a-project" + "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": "Delete Success" + "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, + "404": { + "$ref": "#/components/responses/not_found" + }, "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } + "$ref": "#/components/responses/forbidden" + }, + "422": { + "$ref": "#/components/responses/validation_failed" }, "401": { "$ref": "#/components/responses/requires_authentication" - }, - "410": { - "$ref": "#/components/responses/gone" - }, - "404": { - "$ref": "#/components/responses/not_found" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects-classic", - "subcategory": "projects", + "subcategory": "collaborators", "deprecationDate": "2024-05-23", "removalDate": "2025-04-01" }, "deprecated": true } }, - "/projects/{project_id}/collaborators": { + "/projects/{project_id}/collaborators/{username}/permission": { "get": { - "summary": "List project collaborators", + "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/list-collaborators", + "operationId": "projects-classic/get-permission-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators" + "url": "https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user" }, "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" + "$ref": "#/components/parameters/username" } ], "responses": { @@ -30349,218 +30508,11 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - } + "$ref": "#/components/schemas/project-collaborator-permission" }, "examples": { "default": { - "$ref": "#/components/examples/simple-user-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}": { - "put": { - "summary": "Add project collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/add-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": [ - "object", - "null" - ], - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "type": "string", - "examples": [ - "write" - ] - } - } - }, - "examples": { - "default": { - "summary": "Applying write permissions for the new collaborator", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove user as a collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/remove-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}/permission": { - "get": { - "summary": "Get project permission for a user", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-permission-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-collaborator-permission" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-collaborator-permission" + "$ref": "#/components/examples/project-collaborator-permission" } } } @@ -56877,190 +56829,6 @@ } } }, - "/repos/{owner}/{repo}/projects": { - "get": { - "summary": "List repository 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#list-repository-projects" - }, - "parameters": [ - { - "$ref": "#/components/parameters/owner" - }, - { - "$ref": "#/components/parameters/repo" - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/project" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-items-2" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "410": { - "$ref": "#/components/responses/gone" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create a repository 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#create-a-repository-project" - }, - "parameters": [ - { - "$ref": "#/components/parameters/owner" - }, - { - "$ref": "#/components/parameters/repo" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the project." - }, - "body": { - "type": "string", - "description": "The description of the project." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-3" - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "410": { - "$ref": "#/components/responses/gone" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/repos/{owner}/{repo}/properties/values": { "get": { "summary": "Get all custom property values for a repository", @@ -62085,8 +61853,12 @@ "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" } }, - "required": [ - "state" + "anyOf": [ + { + "required": [ + "state" + ] + } ] }, "examples": { @@ -72229,100 +72001,6 @@ } } }, - "/user/projects": { - "post": { - "summary": "Create a user 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#create-a-user-project" - }, - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Create a new project", - "value": { - "name": "My Projects", - "body": "A board to manage my personal projects." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project" - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/user/public_emails": { "get": { "summary": "List public email addresses for the authenticated user", @@ -75552,42 +75230,39 @@ } } }, - "/users/{username}/projects": { + "/users/{username}/projectsV2": { "get": { - "summary": "List user 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 projects for user", + "description": "List all projects owned by a specific user accessible by the authenticated user.", "tags": [ - "projects-classic" + "projects" ], - "operationId": "projects-classic/list-for-user", + "operationId": "projects/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#list-user-projects" + "url": "https://docs.github.com/rest/projects/projects#list-projects-for-user" }, "parameters": [ { "$ref": "#/components/parameters/username" }, { - "name": "state", - "description": "Indicates the state of the projects to return.", + "name": "q", + "description": "Limit results to projects of the specified type.", "in": "query", "required": false, "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" + "type": "string" } }, { - "$ref": "#/components/parameters/per-page" + "$ref": "#/components/parameters/pagination-before" }, { - "$ref": "#/components/parameters/page" + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/per-page" } ], "responses": { @@ -75598,12 +75273,12 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/project" + "$ref": "#/components/schemas/projects-v2" } }, "examples": { "default": { - "$ref": "#/components/examples/project-items-3" + "$ref": "#/components/examples/projects-v2" } } } @@ -75614,54 +75289,110 @@ } } }, - "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": false, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "projects" + } } }, - "/users/{username}/projectsV2": { + "/users/{username}/projectsV2/{project_number}": { "get": { - "summary": "List projects for user", - "description": "List all projects owned by a specific user accessible by the authenticated user.", + "summary": "Get project for user", + "description": "Get a specific user-owned project.", "tags": [ "projects" ], - "operationId": "projects/list-for-user", + "operationId": "projects/get-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/projects#list-projects-for-user" + "url": "https://docs.github.com/rest/projects/projects#get-project-for-user" }, "parameters": [ { - "$ref": "#/components/parameters/username" + "$ref": "#/components/parameters/project-number" }, { - "name": "q", - "description": "Limit results to projects of the specified type.", - "in": "query", - "required": false, - "schema": { - "type": "string" + "$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/pagination-before" + "$ref": "#/components/parameters/project-number" }, { - "$ref": "#/components/parameters/pagination-after" + "$ref": "#/components/parameters/username" }, { "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" } ], "responses": { @@ -75672,12 +75403,12 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/projects-v2" + "$ref": "#/components/schemas/projects-v2-field" } }, "examples": { "default": { - "$ref": "#/components/examples/projects-v2" + "$ref": "#/components/examples/projects-v2-field-items" } } } @@ -75702,26 +75433,29 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "fields" } } }, - "/users/{username}/projectsV2/{project_number}": { + "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { "get": { - "summary": "Get project for user", - "description": "Get a specific user-owned project.", + "summary": "Get project field for user", + "description": "Get a specific field for a user-owned project.", "tags": [ "projects" ], - "operationId": "projects/get-for-user", + "operationId": "projects/get-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#get-project-field-for-user" }, "parameters": [ { "$ref": "#/components/parameters/project-number" }, + { + "$ref": "#/components/parameters/field-id" + }, { "$ref": "#/components/parameters/username" } @@ -75732,11 +75466,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/projects-v2" + "$ref": "#/components/schemas/projects-v2-field" }, "examples": { "default": { - "$ref": "#/components/examples/projects-v2" + "$ref": "#/components/examples/projects-v2-field" } } } @@ -75761,21 +75495,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "fields" } } }, - "/users/{username}/projectsV2/{project_number}/fields": { + "/users/{username}/projectsV2/{project_number}/items": { "get": { - "summary": "List project fields for user", - "description": "List all fields for a specific user-owned project.", + "summary": "List items for a user owned project", + "description": "List all items for a specific user-owned project accessible by the authenticated user.", "tags": [ "projects" ], - "operationId": "projects/list-fields-for-user", + "operationId": "projects/list-items-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/fields#list-project-fields-for-user" + "url": "https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project" }, "parameters": [ { @@ -75784,14 +75518,43 @@ { "$ref": "#/components/parameters/username" }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, { "$ref": "#/components/parameters/per-page" }, { - "$ref": "#/components/parameters/pagination-before" + "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" + } }, { - "$ref": "#/components/parameters/pagination-after" + "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": { @@ -75802,174 +75565,12 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/projects-v2-field" + "$ref": "#/components/schemas/projects-v2-item-with-content" } }, "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}/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": [ - { - "$ref": "#/components/parameters/project-number" - }, - { - "$ref": "#/components/parameters/field-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/projects-v2-field" - }, - "examples": { - "default": { - "$ref": "#/components/examples/projects-v2-field" - } - } - } - }, - "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}/items": { - "get": { - "summary": "List items for a user owned project", - "description": "List all items for a specific user-owned project accessible by the authenticated user.", - "tags": [ - "projects" - ], - "operationId": "projects/list-items-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-number" - }, - { - "$ref": "#/components/parameters/username" - }, - { - "$ref": "#/components/parameters/pagination-before" - }, - { - "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "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" - } - } - ] - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/projects-v2-item-with-content" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/projects-v2-item-with-content" + "$ref": "#/components/examples/projects-v2-item-with-content" } } } @@ -76835,7 +76436,7 @@ }, "/users/{username}/settings/billing/usage/summary": { "get": { - "summary": "Get billing usage summary report for a user", + "summary": "Get billing usage summary for a user", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" @@ -76843,7 +76444,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-report-for-a-user" + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-for-a-user" }, "parameters": [ { @@ -110105,6 +109706,217 @@ "value" ] }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the budget", + "examples": [ + "2066deda-923f-43f9-88d2-62395a28c0cdd" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "SkuPricing", + "ProductPricing" + ], + "examples": [ + "SkuPricing" + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount limit in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "The type of limit enforcement for the budget", + "examples": [ + true + ] + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "examples": [ + "octocat/hello-world" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to." + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + }, + "required": [ + "will_alert", + "alert_recipients" + ] + } + }, + "required": [ + "id", + "budget_type", + "budget_product_sku", + "budget_scope", + "budget_amount", + "prevent_further_usage", + "budget_alerting" + ] + }, + "get_all_budgets": { + "type": "object", + "properties": { + "budgets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/budget" + }, + "description": "Array of budget objects for the enterprise" + } + }, + "required": [ + "budgets" + ] + }, + "get-budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ], + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "examples": [ + "octocat/hello-world" + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "examples": [ + true + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "examples": [ + "actions_linux" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ], + "examples": [ + "ProductPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + } + } + }, + "required": [ + "id", + "budget_amount", + "prevent_further_usage", + "budget_product_sku", + "budget_type", + "budget_alerting", + "budget_scope", + "budget_entity_name" + ] + }, + "delete-budget": { + "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" + ] + }, "billing-premium-request-usage-report-org": { "type": "object", "properties": { @@ -115583,136 +115395,6 @@ "updated_at" ] }, - "project": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, "projects-v2-status-update": { "title": "Projects v2 Status Update", "description": "An status update belonging to a project", @@ -290598,6 +290280,83 @@ ] } }, + "get_all_budgets": { + "value": { + "budgets": [ + { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "actions" + ], + "budget_scope": "enterprise", + "budget_amount": 1000.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "enterprise-admin", + "billing-manager" + ] + } + }, + { + "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", + "budget_type": "SkuPricing", + "budget_product_skus": [ + "actions_linux" + ], + "budget_scope": "organization", + "budget_amount": 500.0, + "prevent_further_usage": false, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "org-owner" + ] + } + }, + { + "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "packages" + ], + "budget_scope": "cost_center", + "budget_amount": 250.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + ] + } + }, + "get-budget": { + "value": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_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.", + "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" + } + }, "billing-premium-request-usage-report-org": { "value": { "timePeriod": { @@ -294981,82 +294740,6 @@ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" } }, - "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": true - } - ] - }, - "project-2": { - "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" - } - }, "projects-v2": { "value": { "id": 2, @@ -298383,42 +298066,6 @@ "updated_at": "2016-09-05T14:22:28Z" } }, - "project-3": { - "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - }, "project-collaborator-permission": { "value": { "permission": "admin", @@ -308543,44 +308190,6 @@ } } }, - "project-items-2": { - "value": [ - { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - ] - }, "pull-request": { "value": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -315494,42 +315103,6 @@ } } }, - "project": { - "value": { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - }, "repository-items-default-response": { "summary": "Default response", "value": [ @@ -316211,44 +315784,6 @@ } } }, - "project-items-3": { - "value": [ - { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - ] - }, "user-received-events-items": { "value": [ { @@ -318454,6 +317989,15 @@ "type": "integer" } }, + "budget": { + "name": "budget_id", + "description": "The ID corresponding to the budget.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "billing-usage-report-year": { "name": "year", "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.", @@ -320123,6 +319667,51 @@ } } }, + "get_all_budgets": { + "description": "Response when getting all budgets", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get_all_budgets" + }, + "examples": { + "default": { + "$ref": "#/components/examples/get_all_budgets" + } + } + } + } + }, + "budget": { + "description": "Response when updating a budget", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get-budget" + }, + "examples": { + "default": { + "$ref": "#/components/examples/get-budget" + } + } + } + } + }, + "delete-budget": { + "description": "Response when deleting a budget", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/delete-budget" + }, + "examples": { + "default": { + "$ref": "#/components/examples/delete-budget" + } + } + } + } + }, "billing_premium_request_usage_report_org": { "description": "Response when getting a billing premium request usage report", "content": { @@ -320154,7 +319743,7 @@ } }, "billing_usage_summary_report_org": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { @@ -320269,8 +319858,8 @@ "package_es_list_error": { "description": "The value of `per_page` multiplied by `page` cannot be greater than 10000." }, - "gone": { - "description": "Gone", + "temporary_redirect": { + "description": "Temporary Redirect", "content": { "application/json": { "schema": { @@ -320279,8 +319868,8 @@ } } }, - "temporary_redirect": { - "description": "Temporary Redirect", + "gone": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -320428,7 +320017,7 @@ } }, "billing_usage_summary_report_user": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index f1dd6a9d2..0754c99cd 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -5402,6 +5402,286 @@ paths: enabledForGitHubApps: true category: orgs subcategory: custom-properties-for-orgs + "/organizations/{org}/settings/billing/budgets": + get: + summary: Get all budgets for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-all-budgets-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#get-all-budgets-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + "$ref": "#/components/responses/get_all_budgets" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing + "/organizations/{org}/settings/billing/budgets/{budget_id}": + get: + summary: Get a budget by ID for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a budget by ID. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#get-a-budget-by-id-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/budget" + responses: + '200': + "$ref": "#/components/responses/budget" + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing + patch: + summary: Update a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/update-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/budget" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered in the + budget + examples: + update-budget: + summary: Update budget example + value: + prevent_further_usage: false + budget_amount: 10 + budget_alerting: + will_alert: false + alert_recipients: [] + responses: + '200': + description: Budget updated successfully + content: + application/json: + schema: + type: object + properties: + message: + type: string + examples: + - Budget successfully updated. + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_amount: + type: number + format: float + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the + budget is exceeded + budget_alerting: + type: object + required: + - will_alert + - alert_recipients + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + default: '' + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered + in the budget + examples: + update-budget: + value: + message: Budget successfully updated. + id: 550e8400-e29b-41d4-a716-446655440000 + '400': + "$ref": "#/components/responses/bad_request" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + description: Budget not found or feature not enabled + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + budget-not-found: + value: + message: Budget with ID 550e8400-e29b-41d4-a716-446655440000 not + found. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + feature-not-enabled: + value: + message: Not Found + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + '422': + "$ref": "#/components/responses/validation_failed" + '500': + description: Internal server error + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + server-error: + value: + message: Unable to update budget. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + delete: + summary: Delete a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/delete-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#delete-a-budget-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/budget" + responses: + '200': + "$ref": "#/components/responses/delete-budget" + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization @@ -5477,7 +5757,7 @@ paths: subcategory: enhanced-billing "/organizations/{org}/settings/billing/usage/summary": get: - summary: Get billing usage summary report for an organization + summary: Get billing usage summary for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. @@ -5490,7 +5770,7 @@ paths: operationId: billing/get-github-billing-usage-summary-report-org externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-report-for-an-organization + url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/billing-usage-report-year" @@ -16991,121 +17271,6 @@ paths: enabledForGitHubApps: true category: private-registries subcategory: organization-configurations - "/orgs/{org}/projects": - get: - summary: List organization 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: - - projects-classic - operationId: projects-classic/list-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#list-organization-projects - parameters: - - "$ref": "#/components/parameters/org" - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-items" - headers: - Link: - "$ref": "#/components/headers/link" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create an organization 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: - - projects-classic - operationId: projects-classic/create-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#create-an-organization-project - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the project. - body: - type: string - description: The description of the project. - required: - - name - examples: - default: - value: - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-2" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '410': - "$ref": "#/components/responses/gone" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/orgs/{org}/projectsV2": get: summary: List projects for organization @@ -21691,194 +21856,6 @@ paths: deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true - "/projects/{project_id}": - get: - summary: Get 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: - - projects-classic - operationId: projects-classic/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#get-a-project - parameters: - - "$ref": "#/components/parameters/project-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-3" - '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: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update 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. - operationId: projects-classic/update - tags: - - projects-classic - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#update-a-project - parameters: - - "$ref": "#/components/parameters/project-id" - requestBody: - required: false - content: - application/json: - schema: - properties: - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - state: - description: State of the project; either 'open' or 'closed' - type: string - examples: - - open - organization_permission: - description: The baseline permission that all organization members - have on this project - type: string - enum: - - read - - write - - admin - - none - private: - description: Whether or not this project can be seen by everyone. - type: boolean - type: object - examples: - default: - summary: Change the name, state, and permissions for a project - value: - name: Week One Sprint - state: open - organization_permission: write - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-3" - '404': - description: Not Found if the authenticated user does not have access to - the project - '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" - '410': - "$ref": "#/components/responses/gone" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete 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. - operationId: projects-classic/delete - tags: - - projects-classic - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#delete-a-project - parameters: - - "$ref": "#/components/parameters/project-id" - responses: - '204': - description: Delete Success - '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" - '410': - "$ref": "#/components/responses/gone" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/projects/{project_id}/collaborators": get: summary: List project collaborators @@ -41213,131 +41190,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repos/{owner}/{repo}/projects": - get: - summary: List repository 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: - - projects-classic - operationId: projects-classic/list-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#list-repository-projects - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-items-2" - headers: - Link: - "$ref": "#/components/headers/link" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '410': - "$ref": "#/components/responses/gone" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create a repository 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: - - projects-classic - operationId: projects-classic/create-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#create-a-repository-project - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the project. - body: - type: string - description: The description of the project. - required: - - name - examples: - default: - value: - name: Projects Documentation - body: Developer documentation project for the developer site. - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-3" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '410': - "$ref": "#/components/responses/gone" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/repos/{owner}/{repo}/properties/values": get: summary: Get all custom property values for a repository @@ -44973,8 +44825,9 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution" resolution_comment: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" - required: - - state + anyOf: + - required: + - state examples: default: value: @@ -52369,73 +52222,6 @@ paths: enabledForGitHubApps: false category: packages subcategory: packages - "/user/projects": - post: - summary: Create a user 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: - - projects-classic - operationId: projects-classic/create-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#create-a-user-project - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - required: - - name - type: object - examples: - default: - summary: Create a new project - value: - name: My Projects - body: A board to manage my personal projects. - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/user/public_emails": get: summary: List public email addresses for the authenticated user @@ -54704,59 +54490,6 @@ paths: enabledForGitHubApps: false category: packages subcategory: packages - "/users/{username}/projects": - get: - summary: List user 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: - - projects-classic - operationId: projects-classic/list-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#list-user-projects - parameters: - - "$ref": "#/components/parameters/username" - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-items-3" - headers: - Link: - "$ref": "#/components/headers/link" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/users/{username}/projectsV2": get: summary: List projects for user @@ -55546,7 +55279,7 @@ paths: subcategory: enhanced-billing "/users/{username}/settings/billing/usage/summary": get: - summary: Get billing usage summary report for a user + summary: Get billing usage summary for a user description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. @@ -55559,7 +55292,7 @@ paths: operationId: billing/get-github-billing-usage-summary-report-user externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-report-for-a-user + url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-for-a-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/billing-usage-report-year" @@ -79602,6 +79335,163 @@ components: required: - property_name - value + budget: + type: object + properties: + id: + type: string + description: The unique identifier for the budget + examples: + - 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: + type: string + description: The type of pricing for the budget + enum: + - SkuPricing + - ProductPricing + examples: + - SkuPricing + budget_amount: + type: integer + description: The budget amount limit in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: The type of limit enforcement for the budget + examples: + - true + budget_scope: + type: string + description: The scope of the budget (enterprise, organization, repository, + cost center) + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity for the budget (enterprise does not + require a name). + examples: + - octocat/hello-world + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + examples: + - mona + - lisa + required: + - will_alert + - alert_recipients + required: + - id + - budget_type + - budget_product_sku + - budget_scope + - budget_amount + - prevent_further_usage + - budget_alerting + get_all_budgets: + type: object + properties: + budgets: + type: array + items: + "$ref": "#/components/schemas/budget" + description: Array of budget objects for the enterprise + required: + - budgets + get-budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + enum: + - enterprise + - organization + - repository + - cost_center + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + examples: + - octocat/hello-world + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based products, + this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget is exceeded + examples: + - true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + examples: + - actions_linux + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + examples: + - ProductPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + examples: + - mona + - lisa + required: + - id + - budget_amount + - prevent_further_usage + - budget_product_sku + - budget_type + - budget_alerting + - budget_scope + - budget_entity_name + delete-budget: + 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 billing-premium-request-usage-report-org: type: object properties: @@ -83817,101 +83707,6 @@ components: - visibility - created_at - updated_at - project: - title: Project - description: Projects are a way to organize columns and cards of work. - type: object - properties: - owner_url: - type: string - format: uri - examples: - - https://api.github.com/repos/api-playground/projects-test - url: - type: string - format: uri - examples: - - https://api.github.com/projects/1002604 - html_url: - type: string - format: uri - examples: - - https://github.com/api-playground/projects-test/projects/12 - columns_url: - type: string - format: uri - examples: - - https://api.github.com/projects/1002604/columns - id: - type: integer - examples: - - 1002604 - node_id: - type: string - examples: - - MDc6UHJvamVjdDEwMDI2MDQ= - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - number: - type: integer - examples: - - 1 - state: - description: State of the project; either 'open' or 'closed' - type: string - examples: - - open - creator: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - created_at: - type: string - format: date-time - examples: - - '2011-04-10T20:09:31Z' - updated_at: - type: string - format: date-time - examples: - - '2014-03-03T18:58:10Z' - organization_permission: - description: The baseline permission that all organization members have - on this project. Only present if owner is an organization. - type: string - enum: - - read - - write - - admin - - none - private: - description: Whether or not this project can be seen by everyone. Only present - if owner is an organization. - type: boolean - required: - - id - - node_id - - number - - name - - body - - state - - url - - html_url - - owner_url - - creator - - columns_url - - created_at - - updated_at projects-v2-status-update: title: Projects v2 Status Update description: An status update belonging to a project @@ -214264,6 +214059,60 @@ components: value: web - property_name: team value: octocat + get_all_budgets: + value: + budgets: + - id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_skus: + - actions + budget_scope: enterprise + budget_amount: 1000.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - enterprise-admin + - billing-manager + - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 + budget_type: SkuPricing + budget_product_skus: + - actions_linux + budget_scope: organization + budget_amount: 500.0 + prevent_further_usage: false + budget_alerting: + will_alert: true + alert_recipients: + - org-owner + - id: 6ba7b810-9dad-11d1-80b4-00c04fd430c8 + budget_type: ProductPricing + budget_product_skus: + - packages + budget_scope: cost_center + budget_amount: 250.0 + prevent_further_usage: true + budget_alerting: + will_alert: false + alert_recipients: [] + get-budget: + value: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_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. + budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b billing-premium-request-usage-report-org: value: timePeriod: @@ -217935,74 +217784,6 @@ components: value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - 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: true - project-2: - 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' projects-v2: value: id: 2 @@ -220876,39 +220657,6 @@ components: name: To Do created_at: '2016-09-05T14:18:44Z' updated_at: '2016-09-05T14:22:28Z' - project-3: - value: - owner_url: https://api.github.com/repos/api-playground/projects-test - url: https://api.github.com/projects/1002604 - html_url: https://github.com/api-playground/projects-test/projects/1 - columns_url: https://api.github.com/projects/1002604/columns - id: 1002604 - node_id: MDc6UHJvamVjdDEwMDI2MDQ= - name: Projects Documentation - body: Developer documentation project for the developer site. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' project-collaborator-permission: value: permission: admin @@ -229544,39 +229292,6 @@ components: https_error: is_https_eligible: true caa_error: - project-items-2: - value: - - owner_url: https://api.github.com/repos/api-playground/projects-test - url: https://api.github.com/projects/1002604 - html_url: https://github.com/api-playground/projects-test/projects/1 - columns_url: https://api.github.com/projects/1002604/columns - id: 1002604 - node_id: MDc6UHJvamVjdDEwMDI2MDQ= - name: Projects Documentation - body: Developer documentation project for the developer site. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' pull-request: value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 @@ -235623,39 +235338,6 @@ components: container: tags: - 1.13.6 - project: - value: - owner_url: https://api.github.com/users/octocat - url: https://api.github.com/projects/1002603 - html_url: https://github.com/users/octocat/projects/1 - columns_url: https://api.github.com/projects/1002603/columns - id: 1002603 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - name: My Projects - body: A board to manage my personal projects. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' repository-items-default-response: summary: Default response value: @@ -236237,39 +235919,6 @@ components: html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0 metadata: package_type: rubygems - project-items-3: - value: - - owner_url: https://api.github.com/users/octocat - url: https://api.github.com/projects/1002603 - html_url: https://github.com/users/octocat/projects/1 - columns_url: https://api.github.com/projects/1002603/columns - id: 1002603 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - name: My Projects - body: A board to manage my personal projects. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' user-received-events-items: value: - id: '22249084964' @@ -238230,6 +237879,13 @@ components: required: false schema: type: integer + budget: + name: budget_id + description: The ID corresponding to the budget. + in: path + required: true + schema: + type: string billing-usage-report-year: name: year description: If specified, only return results for a single year. The value @@ -239616,6 +239272,33 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + get_all_budgets: + description: Response when getting all budgets + content: + application/json: + schema: + "$ref": "#/components/schemas/get_all_budgets" + examples: + default: + "$ref": "#/components/examples/get_all_budgets" + budget: + description: Response when updating a budget + content: + application/json: + schema: + "$ref": "#/components/schemas/get-budget" + examples: + default: + "$ref": "#/components/examples/get-budget" + delete-budget: + description: Response when deleting a budget + content: + application/json: + schema: + "$ref": "#/components/schemas/delete-budget" + examples: + default: + "$ref": "#/components/examples/delete-budget" billing_premium_request_usage_report_org: description: Response when getting a billing premium request usage report content: @@ -239635,7 +239318,7 @@ components: default: "$ref": "#/components/examples/billing-usage-report" billing_usage_summary_report_org: - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -239709,14 +239392,14 @@ components: package_es_list_error: description: The value of `per_page` multiplied by `page` cannot be greater than 10000. - gone: - description: Gone + temporary_redirect: + description: Temporary Redirect content: application/json: schema: "$ref": "#/components/schemas/basic-error" - temporary_redirect: - description: Temporary Redirect + gone: + description: Gone content: application/json: schema: @@ -239810,7 +239493,7 @@ components: default: "$ref": "#/components/examples/billing-usage-report-user" billing_usage_summary_report_user: - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 94467be58..a0db7a66d 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -7674,6 +7674,387 @@ } } }, + "/organizations/{org}/settings/billing/budgets": { + "get": { + "summary": "Get all budgets for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all budgets for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-all-budgets-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-all-budgets-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/get_all_budgets" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, + "/organizations/{org}/settings/billing/budgets/{budget_id}": { + "get": { + "summary": "Get a budget by ID for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a budget by ID. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-a-budget-by-id-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/budget" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/budget" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "patch": { + "summary": "Update a budget for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nUpdates an existing budget for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/update-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/budget" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + }, + "examples": { + "update-budget": { + "summary": "Update budget example", + "value": { + "prevent_further_usage": false, + "budget_amount": 10, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Budget updated successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": [ + "Budget successfully updated." + ] + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "required": [ + "will_alert", + "alert_recipients" + ], + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "default": "" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + } + } + }, + "examples": { + "update-budget": { + "value": { + "message": "Budget successfully updated.", + "id": "550e8400-e29b-41d4-a716-446655440000" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "description": "Budget not found or feature not enabled", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "budget-not-found": { + "value": { + "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget" + } + }, + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget" + } + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to update budget.", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "delete": { + "summary": "Delete a budget for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/delete-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/enhanced-billing#delete-a-budget-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/budget" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/delete-budget" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", @@ -7790,7 +8171,7 @@ }, "/organizations/{org}/settings/billing/usage/summary": { "get": { - "summary": "Get billing usage summary report for an organization", + "summary": "Get billing usage summary for an organization", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" @@ -7798,7 +8179,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-report-for-an-organization" + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-for-an-organization" }, "parameters": [ { @@ -23466,172 +23847,6 @@ } } }, - "/orgs/{org}/projects": { - "get": { - "summary": "List organization 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#list-organization-projects" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/project" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create an organization 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#create-an-organization-project" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the project." - }, - "body": { - "type": "string", - "description": "The description of the project." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-2" - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "410": { - "$ref": "#/components/responses/gone" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/orgs/{org}/projectsV2": { "get": { "summary": "List projects for organization", @@ -30042,21 +30257,42 @@ "deprecated": true } }, - "/projects/{project_id}": { + "/projects/{project_id}/collaborators": { "get": { - "summary": "Get a project", + "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/get", + "operationId": "projects-classic/list-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#get-a-project" + "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": { @@ -30065,16 +30301,30 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/project" + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } }, "examples": { "default": { - "$ref": "#/components/examples/project-3" + "$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" }, @@ -30089,26 +30339,31 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects-classic", - "subcategory": "projects", + "subcategory": "collaborators", "deprecationDate": "2024-05-23", "removalDate": "2025-04-01" }, "deprecated": true - }, - "patch": { - "summary": "Update a project", + } + }, + "/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.", - "operationId": "projects-classic/update", "tags": [ "projects-classic" ], + "operationId": "projects-classic/add-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#update-a-project" + "url": "https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator" }, "parameters": [ { "$ref": "#/components/parameters/project-id" + }, + { + "$ref": "#/components/parameters/username" } ], "requestBody": { @@ -30116,55 +30371,31 @@ "content": { "application/json": { "schema": { + "type": [ + "object", + "null" + ], "properties": { - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project", - "type": "string", + "permission": { + "description": "The permission to grant the collaborator.", "enum": [ "read", "write", - "admin", - "none" + "admin" + ], + "default": "write", + "type": "string", + "examples": [ + "write" ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone.", - "type": "boolean" } - }, - "type": "object" + } }, "examples": { "default": { - "summary": "Change the name, state, and permissions for a project", + "summary": "Applying write permissions for the new collaborator", "value": { - "name": "Week One Sprint", - "state": "open", - "organization_permission": "write" + "permission": "write" } } } @@ -30172,175 +30403,103 @@ } }, "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-3" - } - } - } - } + "204": { + "description": "Response" }, "404": { - "description": "Not Found if the authenticated user does not have access to the project" + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" }, "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" - } - } - } - } - } - } + "$ref": "#/components/responses/forbidden" }, "401": { "$ref": "#/components/responses/requires_authentication" - }, - "410": { - "$ref": "#/components/responses/gone" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects-classic", - "subcategory": "projects", + "subcategory": "collaborators", "deprecationDate": "2024-05-23", "removalDate": "2025-04-01" }, "deprecated": true }, "delete": { - "summary": "Delete a project", + "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.", - "operationId": "projects-classic/delete", "tags": [ "projects-classic" ], + "operationId": "projects-classic/remove-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#delete-a-project" + "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": "Delete Success" + "description": "Response" }, "304": { "$ref": "#/components/responses/not_modified" }, + "404": { + "$ref": "#/components/responses/not_found" + }, "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } + "$ref": "#/components/responses/forbidden" + }, + "422": { + "$ref": "#/components/responses/validation_failed" }, "401": { "$ref": "#/components/responses/requires_authentication" - }, - "410": { - "$ref": "#/components/responses/gone" - }, - "404": { - "$ref": "#/components/responses/not_found" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects-classic", - "subcategory": "projects", + "subcategory": "collaborators", "deprecationDate": "2024-05-23", "removalDate": "2025-04-01" }, "deprecated": true } }, - "/projects/{project_id}/collaborators": { + "/projects/{project_id}/collaborators/{username}/permission": { "get": { - "summary": "List project collaborators", + "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/list-collaborators", + "operationId": "projects-classic/get-permission-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators" + "url": "https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user" }, "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" + "$ref": "#/components/parameters/username" } ], "responses": { @@ -30349,218 +30508,11 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - } + "$ref": "#/components/schemas/project-collaborator-permission" }, "examples": { "default": { - "$ref": "#/components/examples/simple-user-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}": { - "put": { - "summary": "Add project collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/add-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": [ - "object", - "null" - ], - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "type": "string", - "examples": [ - "write" - ] - } - } - }, - "examples": { - "default": { - "summary": "Applying write permissions for the new collaborator", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove user as a collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/remove-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}/permission": { - "get": { - "summary": "Get project permission for a user", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-permission-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-collaborator-permission" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-collaborator-permission" + "$ref": "#/components/examples/project-collaborator-permission" } } } @@ -56877,190 +56829,6 @@ } } }, - "/repos/{owner}/{repo}/projects": { - "get": { - "summary": "List repository 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#list-repository-projects" - }, - "parameters": [ - { - "$ref": "#/components/parameters/owner" - }, - { - "$ref": "#/components/parameters/repo" - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/project" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-items-2" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "410": { - "$ref": "#/components/responses/gone" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create a repository 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#create-a-repository-project" - }, - "parameters": [ - { - "$ref": "#/components/parameters/owner" - }, - { - "$ref": "#/components/parameters/repo" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the project." - }, - "body": { - "type": "string", - "description": "The description of the project." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-3" - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "410": { - "$ref": "#/components/responses/gone" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/repos/{owner}/{repo}/properties/values": { "get": { "summary": "Get all custom property values for a repository", @@ -62085,8 +61853,12 @@ "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" } }, - "required": [ - "state" + "anyOf": [ + { + "required": [ + "state" + ] + } ] }, "examples": { @@ -72229,100 +72001,6 @@ } } }, - "/user/projects": { - "post": { - "summary": "Create a user 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#create-a-user-project" - }, - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Create a new project", - "value": { - "name": "My Projects", - "body": "A board to manage my personal projects." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project" - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/user/public_emails": { "get": { "summary": "List public email addresses for the authenticated user", @@ -75552,42 +75230,39 @@ } } }, - "/users/{username}/projects": { + "/users/{username}/projectsV2": { "get": { - "summary": "List user 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 projects for user", + "description": "List all projects owned by a specific user accessible by the authenticated user.", "tags": [ - "projects-classic" + "projects" ], - "operationId": "projects-classic/list-for-user", + "operationId": "projects/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#list-user-projects" + "url": "https://docs.github.com/rest/projects/projects#list-projects-for-user" }, "parameters": [ { "$ref": "#/components/parameters/username" }, { - "name": "state", - "description": "Indicates the state of the projects to return.", + "name": "q", + "description": "Limit results to projects of the specified type.", "in": "query", "required": false, "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" + "type": "string" } }, { - "$ref": "#/components/parameters/per-page" + "$ref": "#/components/parameters/pagination-before" }, { - "$ref": "#/components/parameters/page" + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/per-page" } ], "responses": { @@ -75598,12 +75273,12 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/project" + "$ref": "#/components/schemas/projects-v2" } }, "examples": { "default": { - "$ref": "#/components/examples/project-items-3" + "$ref": "#/components/examples/projects-v2" } } } @@ -75614,54 +75289,110 @@ } } }, - "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": false, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "projects" + } } }, - "/users/{username}/projectsV2": { + "/users/{username}/projectsV2/{project_number}": { "get": { - "summary": "List projects for user", - "description": "List all projects owned by a specific user accessible by the authenticated user.", + "summary": "Get project for user", + "description": "Get a specific user-owned project.", "tags": [ "projects" ], - "operationId": "projects/list-for-user", + "operationId": "projects/get-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/projects#list-projects-for-user" + "url": "https://docs.github.com/rest/projects/projects#get-project-for-user" }, "parameters": [ { - "$ref": "#/components/parameters/username" + "$ref": "#/components/parameters/project-number" }, { - "name": "q", - "description": "Limit results to projects of the specified type.", - "in": "query", - "required": false, - "schema": { - "type": "string" + "$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/pagination-before" + "$ref": "#/components/parameters/project-number" }, { - "$ref": "#/components/parameters/pagination-after" + "$ref": "#/components/parameters/username" }, { "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" } ], "responses": { @@ -75672,12 +75403,12 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/projects-v2" + "$ref": "#/components/schemas/projects-v2-field" } }, "examples": { "default": { - "$ref": "#/components/examples/projects-v2" + "$ref": "#/components/examples/projects-v2-field-items" } } } @@ -75702,26 +75433,29 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "fields" } } }, - "/users/{username}/projectsV2/{project_number}": { + "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { "get": { - "summary": "Get project for user", - "description": "Get a specific user-owned project.", + "summary": "Get project field for user", + "description": "Get a specific field for a user-owned project.", "tags": [ "projects" ], - "operationId": "projects/get-for-user", + "operationId": "projects/get-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#get-project-field-for-user" }, "parameters": [ { "$ref": "#/components/parameters/project-number" }, + { + "$ref": "#/components/parameters/field-id" + }, { "$ref": "#/components/parameters/username" } @@ -75732,11 +75466,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/projects-v2" + "$ref": "#/components/schemas/projects-v2-field" }, "examples": { "default": { - "$ref": "#/components/examples/projects-v2" + "$ref": "#/components/examples/projects-v2-field" } } } @@ -75761,21 +75495,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "fields" } } }, - "/users/{username}/projectsV2/{project_number}/fields": { + "/users/{username}/projectsV2/{project_number}/items": { "get": { - "summary": "List project fields for user", - "description": "List all fields for a specific user-owned project.", + "summary": "List items for a user owned project", + "description": "List all items for a specific user-owned project accessible by the authenticated user.", "tags": [ "projects" ], - "operationId": "projects/list-fields-for-user", + "operationId": "projects/list-items-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/fields#list-project-fields-for-user" + "url": "https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project" }, "parameters": [ { @@ -75784,14 +75518,43 @@ { "$ref": "#/components/parameters/username" }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, { "$ref": "#/components/parameters/per-page" }, { - "$ref": "#/components/parameters/pagination-before" + "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" + } }, { - "$ref": "#/components/parameters/pagination-after" + "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": { @@ -75802,174 +75565,12 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/projects-v2-field" + "$ref": "#/components/schemas/projects-v2-item-with-content" } }, "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}/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": [ - { - "$ref": "#/components/parameters/project-number" - }, - { - "$ref": "#/components/parameters/field-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/projects-v2-field" - }, - "examples": { - "default": { - "$ref": "#/components/examples/projects-v2-field" - } - } - } - }, - "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}/items": { - "get": { - "summary": "List items for a user owned project", - "description": "List all items for a specific user-owned project accessible by the authenticated user.", - "tags": [ - "projects" - ], - "operationId": "projects/list-items-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-number" - }, - { - "$ref": "#/components/parameters/username" - }, - { - "$ref": "#/components/parameters/pagination-before" - }, - { - "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "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" - } - } - ] - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/projects-v2-item-with-content" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/projects-v2-item-with-content" + "$ref": "#/components/examples/projects-v2-item-with-content" } } } @@ -76835,7 +76436,7 @@ }, "/users/{username}/settings/billing/usage/summary": { "get": { - "summary": "Get billing usage summary report for a user", + "summary": "Get billing usage summary for a user", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" @@ -76843,7 +76444,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-report-for-a-user" + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-for-a-user" }, "parameters": [ { @@ -110105,6 +109706,217 @@ "value" ] }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the budget", + "examples": [ + "2066deda-923f-43f9-88d2-62395a28c0cdd" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "SkuPricing", + "ProductPricing" + ], + "examples": [ + "SkuPricing" + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount limit in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "The type of limit enforcement for the budget", + "examples": [ + true + ] + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "examples": [ + "octocat/hello-world" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to." + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + }, + "required": [ + "will_alert", + "alert_recipients" + ] + } + }, + "required": [ + "id", + "budget_type", + "budget_product_sku", + "budget_scope", + "budget_amount", + "prevent_further_usage", + "budget_alerting" + ] + }, + "get_all_budgets": { + "type": "object", + "properties": { + "budgets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/budget" + }, + "description": "Array of budget objects for the enterprise" + } + }, + "required": [ + "budgets" + ] + }, + "get-budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ], + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "examples": [ + "octocat/hello-world" + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "examples": [ + true + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "examples": [ + "actions_linux" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ], + "examples": [ + "ProductPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + } + } + }, + "required": [ + "id", + "budget_amount", + "prevent_further_usage", + "budget_product_sku", + "budget_type", + "budget_alerting", + "budget_scope", + "budget_entity_name" + ] + }, + "delete-budget": { + "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" + ] + }, "billing-premium-request-usage-report-org": { "type": "object", "properties": { @@ -115583,136 +115395,6 @@ "updated_at" ] }, - "project": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, "projects-v2-status-update": { "title": "Projects v2 Status Update", "description": "An status update belonging to a project", @@ -290598,6 +290280,83 @@ ] } }, + "get_all_budgets": { + "value": { + "budgets": [ + { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "actions" + ], + "budget_scope": "enterprise", + "budget_amount": 1000.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "enterprise-admin", + "billing-manager" + ] + } + }, + { + "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", + "budget_type": "SkuPricing", + "budget_product_skus": [ + "actions_linux" + ], + "budget_scope": "organization", + "budget_amount": 500.0, + "prevent_further_usage": false, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "org-owner" + ] + } + }, + { + "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "packages" + ], + "budget_scope": "cost_center", + "budget_amount": 250.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + ] + } + }, + "get-budget": { + "value": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_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.", + "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" + } + }, "billing-premium-request-usage-report-org": { "value": { "timePeriod": { @@ -294981,82 +294740,6 @@ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" } }, - "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": true - } - ] - }, - "project-2": { - "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" - } - }, "projects-v2": { "value": { "id": 2, @@ -298383,42 +298066,6 @@ "updated_at": "2016-09-05T14:22:28Z" } }, - "project-3": { - "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - }, "project-collaborator-permission": { "value": { "permission": "admin", @@ -308543,44 +308190,6 @@ } } }, - "project-items-2": { - "value": [ - { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - ] - }, "pull-request": { "value": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -315494,42 +315103,6 @@ } } }, - "project": { - "value": { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - }, "repository-items-default-response": { "summary": "Default response", "value": [ @@ -316211,44 +315784,6 @@ } } }, - "project-items-3": { - "value": [ - { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - ] - }, "user-received-events-items": { "value": [ { @@ -318454,6 +317989,15 @@ "type": "integer" } }, + "budget": { + "name": "budget_id", + "description": "The ID corresponding to the budget.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "billing-usage-report-year": { "name": "year", "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.", @@ -320123,6 +319667,51 @@ } } }, + "get_all_budgets": { + "description": "Response when getting all budgets", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get_all_budgets" + }, + "examples": { + "default": { + "$ref": "#/components/examples/get_all_budgets" + } + } + } + } + }, + "budget": { + "description": "Response when updating a budget", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get-budget" + }, + "examples": { + "default": { + "$ref": "#/components/examples/get-budget" + } + } + } + } + }, + "delete-budget": { + "description": "Response when deleting a budget", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/delete-budget" + }, + "examples": { + "default": { + "$ref": "#/components/examples/delete-budget" + } + } + } + } + }, "billing_premium_request_usage_report_org": { "description": "Response when getting a billing premium request usage report", "content": { @@ -320154,7 +319743,7 @@ } }, "billing_usage_summary_report_org": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { @@ -320269,8 +319858,8 @@ "package_es_list_error": { "description": "The value of `per_page` multiplied by `page` cannot be greater than 10000." }, - "gone": { - "description": "Gone", + "temporary_redirect": { + "description": "Temporary Redirect", "content": { "application/json": { "schema": { @@ -320279,8 +319868,8 @@ } } }, - "temporary_redirect": { - "description": "Temporary Redirect", + "gone": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -320428,7 +320017,7 @@ } }, "billing_usage_summary_report_user": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index f1dd6a9d2..0754c99cd 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -5402,6 +5402,286 @@ paths: enabledForGitHubApps: true category: orgs subcategory: custom-properties-for-orgs + "/organizations/{org}/settings/billing/budgets": + get: + summary: Get all budgets for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-all-budgets-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#get-all-budgets-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + "$ref": "#/components/responses/get_all_budgets" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing + "/organizations/{org}/settings/billing/budgets/{budget_id}": + get: + summary: Get a budget by ID for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a budget by ID. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#get-a-budget-by-id-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/budget" + responses: + '200': + "$ref": "#/components/responses/budget" + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing + patch: + summary: Update a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/update-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/budget" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered in the + budget + examples: + update-budget: + summary: Update budget example + value: + prevent_further_usage: false + budget_amount: 10 + budget_alerting: + will_alert: false + alert_recipients: [] + responses: + '200': + description: Budget updated successfully + content: + application/json: + schema: + type: object + properties: + message: + type: string + examples: + - Budget successfully updated. + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_amount: + type: number + format: float + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the + budget is exceeded + budget_alerting: + type: object + required: + - will_alert + - alert_recipients + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + default: '' + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered + in the budget + examples: + update-budget: + value: + message: Budget successfully updated. + id: 550e8400-e29b-41d4-a716-446655440000 + '400': + "$ref": "#/components/responses/bad_request" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + description: Budget not found or feature not enabled + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + budget-not-found: + value: + message: Budget with ID 550e8400-e29b-41d4-a716-446655440000 not + found. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + feature-not-enabled: + value: + message: Not Found + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + '422': + "$ref": "#/components/responses/validation_failed" + '500': + description: Internal server error + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + server-error: + value: + message: Unable to update budget. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + delete: + summary: Delete a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/delete-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#delete-a-budget-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/budget" + responses: + '200': + "$ref": "#/components/responses/delete-budget" + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization @@ -5477,7 +5757,7 @@ paths: subcategory: enhanced-billing "/organizations/{org}/settings/billing/usage/summary": get: - summary: Get billing usage summary report for an organization + summary: Get billing usage summary for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. @@ -5490,7 +5770,7 @@ paths: operationId: billing/get-github-billing-usage-summary-report-org externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-report-for-an-organization + url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/billing-usage-report-year" @@ -16991,121 +17271,6 @@ paths: enabledForGitHubApps: true category: private-registries subcategory: organization-configurations - "/orgs/{org}/projects": - get: - summary: List organization 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: - - projects-classic - operationId: projects-classic/list-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#list-organization-projects - parameters: - - "$ref": "#/components/parameters/org" - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-items" - headers: - Link: - "$ref": "#/components/headers/link" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create an organization 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: - - projects-classic - operationId: projects-classic/create-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#create-an-organization-project - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the project. - body: - type: string - description: The description of the project. - required: - - name - examples: - default: - value: - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-2" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '410': - "$ref": "#/components/responses/gone" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/orgs/{org}/projectsV2": get: summary: List projects for organization @@ -21691,194 +21856,6 @@ paths: deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true - "/projects/{project_id}": - get: - summary: Get 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: - - projects-classic - operationId: projects-classic/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#get-a-project - parameters: - - "$ref": "#/components/parameters/project-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-3" - '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: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update 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. - operationId: projects-classic/update - tags: - - projects-classic - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#update-a-project - parameters: - - "$ref": "#/components/parameters/project-id" - requestBody: - required: false - content: - application/json: - schema: - properties: - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - state: - description: State of the project; either 'open' or 'closed' - type: string - examples: - - open - organization_permission: - description: The baseline permission that all organization members - have on this project - type: string - enum: - - read - - write - - admin - - none - private: - description: Whether or not this project can be seen by everyone. - type: boolean - type: object - examples: - default: - summary: Change the name, state, and permissions for a project - value: - name: Week One Sprint - state: open - organization_permission: write - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-3" - '404': - description: Not Found if the authenticated user does not have access to - the project - '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" - '410': - "$ref": "#/components/responses/gone" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete 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. - operationId: projects-classic/delete - tags: - - projects-classic - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#delete-a-project - parameters: - - "$ref": "#/components/parameters/project-id" - responses: - '204': - description: Delete Success - '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" - '410': - "$ref": "#/components/responses/gone" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/projects/{project_id}/collaborators": get: summary: List project collaborators @@ -41213,131 +41190,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repos/{owner}/{repo}/projects": - get: - summary: List repository 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: - - projects-classic - operationId: projects-classic/list-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#list-repository-projects - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-items-2" - headers: - Link: - "$ref": "#/components/headers/link" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '410': - "$ref": "#/components/responses/gone" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create a repository 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: - - projects-classic - operationId: projects-classic/create-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#create-a-repository-project - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the project. - body: - type: string - description: The description of the project. - required: - - name - examples: - default: - value: - name: Projects Documentation - body: Developer documentation project for the developer site. - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-3" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '410': - "$ref": "#/components/responses/gone" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/repos/{owner}/{repo}/properties/values": get: summary: Get all custom property values for a repository @@ -44973,8 +44825,9 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution" resolution_comment: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" - required: - - state + anyOf: + - required: + - state examples: default: value: @@ -52369,73 +52222,6 @@ paths: enabledForGitHubApps: false category: packages subcategory: packages - "/user/projects": - post: - summary: Create a user 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: - - projects-classic - operationId: projects-classic/create-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#create-a-user-project - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - required: - - name - type: object - examples: - default: - summary: Create a new project - value: - name: My Projects - body: A board to manage my personal projects. - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/user/public_emails": get: summary: List public email addresses for the authenticated user @@ -54704,59 +54490,6 @@ paths: enabledForGitHubApps: false category: packages subcategory: packages - "/users/{username}/projects": - get: - summary: List user 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: - - projects-classic - operationId: projects-classic/list-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#list-user-projects - parameters: - - "$ref": "#/components/parameters/username" - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-items-3" - headers: - Link: - "$ref": "#/components/headers/link" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/users/{username}/projectsV2": get: summary: List projects for user @@ -55546,7 +55279,7 @@ paths: subcategory: enhanced-billing "/users/{username}/settings/billing/usage/summary": get: - summary: Get billing usage summary report for a user + summary: Get billing usage summary for a user description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. @@ -55559,7 +55292,7 @@ paths: operationId: billing/get-github-billing-usage-summary-report-user externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-report-for-a-user + url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-for-a-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/billing-usage-report-year" @@ -79602,6 +79335,163 @@ components: required: - property_name - value + budget: + type: object + properties: + id: + type: string + description: The unique identifier for the budget + examples: + - 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: + type: string + description: The type of pricing for the budget + enum: + - SkuPricing + - ProductPricing + examples: + - SkuPricing + budget_amount: + type: integer + description: The budget amount limit in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: The type of limit enforcement for the budget + examples: + - true + budget_scope: + type: string + description: The scope of the budget (enterprise, organization, repository, + cost center) + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity for the budget (enterprise does not + require a name). + examples: + - octocat/hello-world + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + examples: + - mona + - lisa + required: + - will_alert + - alert_recipients + required: + - id + - budget_type + - budget_product_sku + - budget_scope + - budget_amount + - prevent_further_usage + - budget_alerting + get_all_budgets: + type: object + properties: + budgets: + type: array + items: + "$ref": "#/components/schemas/budget" + description: Array of budget objects for the enterprise + required: + - budgets + get-budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + enum: + - enterprise + - organization + - repository + - cost_center + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + examples: + - octocat/hello-world + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based products, + this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget is exceeded + examples: + - true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + examples: + - actions_linux + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + examples: + - ProductPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + examples: + - mona + - lisa + required: + - id + - budget_amount + - prevent_further_usage + - budget_product_sku + - budget_type + - budget_alerting + - budget_scope + - budget_entity_name + delete-budget: + 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 billing-premium-request-usage-report-org: type: object properties: @@ -83817,101 +83707,6 @@ components: - visibility - created_at - updated_at - project: - title: Project - description: Projects are a way to organize columns and cards of work. - type: object - properties: - owner_url: - type: string - format: uri - examples: - - https://api.github.com/repos/api-playground/projects-test - url: - type: string - format: uri - examples: - - https://api.github.com/projects/1002604 - html_url: - type: string - format: uri - examples: - - https://github.com/api-playground/projects-test/projects/12 - columns_url: - type: string - format: uri - examples: - - https://api.github.com/projects/1002604/columns - id: - type: integer - examples: - - 1002604 - node_id: - type: string - examples: - - MDc6UHJvamVjdDEwMDI2MDQ= - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - number: - type: integer - examples: - - 1 - state: - description: State of the project; either 'open' or 'closed' - type: string - examples: - - open - creator: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - created_at: - type: string - format: date-time - examples: - - '2011-04-10T20:09:31Z' - updated_at: - type: string - format: date-time - examples: - - '2014-03-03T18:58:10Z' - organization_permission: - description: The baseline permission that all organization members have - on this project. Only present if owner is an organization. - type: string - enum: - - read - - write - - admin - - none - private: - description: Whether or not this project can be seen by everyone. Only present - if owner is an organization. - type: boolean - required: - - id - - node_id - - number - - name - - body - - state - - url - - html_url - - owner_url - - creator - - columns_url - - created_at - - updated_at projects-v2-status-update: title: Projects v2 Status Update description: An status update belonging to a project @@ -214264,6 +214059,60 @@ components: value: web - property_name: team value: octocat + get_all_budgets: + value: + budgets: + - id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_skus: + - actions + budget_scope: enterprise + budget_amount: 1000.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - enterprise-admin + - billing-manager + - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 + budget_type: SkuPricing + budget_product_skus: + - actions_linux + budget_scope: organization + budget_amount: 500.0 + prevent_further_usage: false + budget_alerting: + will_alert: true + alert_recipients: + - org-owner + - id: 6ba7b810-9dad-11d1-80b4-00c04fd430c8 + budget_type: ProductPricing + budget_product_skus: + - packages + budget_scope: cost_center + budget_amount: 250.0 + prevent_further_usage: true + budget_alerting: + will_alert: false + alert_recipients: [] + get-budget: + value: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_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. + budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b billing-premium-request-usage-report-org: value: timePeriod: @@ -217935,74 +217784,6 @@ components: value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - 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: true - project-2: - 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' projects-v2: value: id: 2 @@ -220876,39 +220657,6 @@ components: name: To Do created_at: '2016-09-05T14:18:44Z' updated_at: '2016-09-05T14:22:28Z' - project-3: - value: - owner_url: https://api.github.com/repos/api-playground/projects-test - url: https://api.github.com/projects/1002604 - html_url: https://github.com/api-playground/projects-test/projects/1 - columns_url: https://api.github.com/projects/1002604/columns - id: 1002604 - node_id: MDc6UHJvamVjdDEwMDI2MDQ= - name: Projects Documentation - body: Developer documentation project for the developer site. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' project-collaborator-permission: value: permission: admin @@ -229544,39 +229292,6 @@ components: https_error: is_https_eligible: true caa_error: - project-items-2: - value: - - owner_url: https://api.github.com/repos/api-playground/projects-test - url: https://api.github.com/projects/1002604 - html_url: https://github.com/api-playground/projects-test/projects/1 - columns_url: https://api.github.com/projects/1002604/columns - id: 1002604 - node_id: MDc6UHJvamVjdDEwMDI2MDQ= - name: Projects Documentation - body: Developer documentation project for the developer site. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' pull-request: value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 @@ -235623,39 +235338,6 @@ components: container: tags: - 1.13.6 - project: - value: - owner_url: https://api.github.com/users/octocat - url: https://api.github.com/projects/1002603 - html_url: https://github.com/users/octocat/projects/1 - columns_url: https://api.github.com/projects/1002603/columns - id: 1002603 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - name: My Projects - body: A board to manage my personal projects. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' repository-items-default-response: summary: Default response value: @@ -236237,39 +235919,6 @@ components: html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0 metadata: package_type: rubygems - project-items-3: - value: - - owner_url: https://api.github.com/users/octocat - url: https://api.github.com/projects/1002603 - html_url: https://github.com/users/octocat/projects/1 - columns_url: https://api.github.com/projects/1002603/columns - id: 1002603 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - name: My Projects - body: A board to manage my personal projects. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' user-received-events-items: value: - id: '22249084964' @@ -238230,6 +237879,13 @@ components: required: false schema: type: integer + budget: + name: budget_id + description: The ID corresponding to the budget. + in: path + required: true + schema: + type: string billing-usage-report-year: name: year description: If specified, only return results for a single year. The value @@ -239616,6 +239272,33 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + get_all_budgets: + description: Response when getting all budgets + content: + application/json: + schema: + "$ref": "#/components/schemas/get_all_budgets" + examples: + default: + "$ref": "#/components/examples/get_all_budgets" + budget: + description: Response when updating a budget + content: + application/json: + schema: + "$ref": "#/components/schemas/get-budget" + examples: + default: + "$ref": "#/components/examples/get-budget" + delete-budget: + description: Response when deleting a budget + content: + application/json: + schema: + "$ref": "#/components/schemas/delete-budget" + examples: + default: + "$ref": "#/components/examples/delete-budget" billing_premium_request_usage_report_org: description: Response when getting a billing premium request usage report content: @@ -239635,7 +239318,7 @@ components: default: "$ref": "#/components/examples/billing-usage-report" billing_usage_summary_report_org: - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -239709,14 +239392,14 @@ components: package_es_list_error: description: The value of `per_page` multiplied by `page` cannot be greater than 10000. - gone: - description: Gone + temporary_redirect: + description: Temporary Redirect content: application/json: schema: "$ref": "#/components/schemas/basic-error" - temporary_redirect: - description: Temporary Redirect + gone: + description: Gone content: application/json: schema: @@ -239810,7 +239493,7 @@ components: default: "$ref": "#/components/examples/billing-usage-report-user" billing_usage_summary_report_user: - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 818f8ff31..e1a28617e 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -61612,6 +61612,1320 @@ } } }, + "/organizations/{org}/settings/billing/budgets": { + "get": { + "summary": "Get all budgets for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all budgets for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-all-budgets-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-all-budgets-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 when getting all budgets", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "budgets": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the budget", + "examples": [ + "2066deda-923f-43f9-88d2-62395a28c0cdd" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "SkuPricing", + "ProductPricing" + ], + "examples": [ + "SkuPricing" + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount limit in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "The type of limit enforcement for the budget", + "examples": [ + true + ] + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "examples": [ + "octocat/hello-world" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to." + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + }, + "required": [ + "will_alert", + "alert_recipients" + ] + } + }, + "required": [ + "id", + "budget_type", + "budget_product_sku", + "budget_scope", + "budget_amount", + "prevent_further_usage", + "budget_alerting" + ] + }, + "description": "Array of budget objects for the enterprise" + } + }, + "required": [ + "budgets" + ] + }, + "examples": { + "default": { + "value": { + "budgets": [ + { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "actions" + ], + "budget_scope": "enterprise", + "budget_amount": 1000.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "enterprise-admin", + "billing-manager" + ] + } + }, + { + "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", + "budget_type": "SkuPricing", + "budget_product_skus": [ + "actions_linux" + ], + "budget_scope": "organization", + "budget_amount": 500.0, + "prevent_further_usage": false, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "org-owner" + ] + } + }, + { + "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "packages" + ], + "budget_scope": "cost_center", + "budget_amount": 250.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + ] + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, + "/organizations/{org}/settings/billing/budgets/{budget_id}": { + "get": { + "summary": "Get a budget by ID for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a budget by ID. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-a-budget-by-id-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "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 updating a budget", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ], + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "examples": [ + "octocat/hello-world" + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "examples": [ + true + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "examples": [ + "actions_linux" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ], + "examples": [ + "ProductPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + } + } + }, + "required": [ + "id", + "budget_amount", + "prevent_further_usage", + "budget_product_sku", + "budget_type", + "budget_alerting", + "budget_scope", + "budget_entity_name" + ] + }, + "examples": { + "default": { + "value": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "patch": { + "summary": "Update a budget for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nUpdates an existing budget for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/update-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "budget_id", + "description": "The ID corresponding to the budget.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + }, + "examples": { + "update-budget": { + "summary": "Update budget example", + "value": { + "prevent_further_usage": false, + "budget_amount": 10, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Budget updated successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": [ + "Budget successfully updated." + ] + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "required": [ + "will_alert", + "alert_recipients" + ], + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "default": "" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + } + } + }, + "examples": { + "update-budget": { + "value": { + "message": "Budget successfully updated.", + "id": "550e8400-e29b-41d4-a716-446655440000" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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/enhanced-billing#update-a-budget" + } + }, + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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 update budget.", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "delete": { + "summary": "Delete a budget for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/delete-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/enhanced-billing#delete-a-budget-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", @@ -62309,7 +63623,7 @@ }, "/organizations/{org}/settings/billing/usage/summary": { "get": { - "summary": "Get billing usage summary report for an organization", + "summary": "Get billing usage summary for an organization", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" @@ -62317,7 +63631,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-report-for-an-organization" + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-for-an-organization" }, "parameters": [ { @@ -62386,7 +63700,7 @@ ], "responses": { "200": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { @@ -147419,999 +148733,6 @@ } } }, - "/orgs/{org}/projects": { - "get": { - "summary": "List organization 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#list-organization-projects" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - } - }, - "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": true - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create an organization 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#create-an-organization-project" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the project." - }, - "body": { - "type": "string", - "description": "The description of the project." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "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" - } - } - } - } - } - }, - "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": "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/orgs/{org}/projectsV2": { "get": { "summary": "List projects for organization", @@ -207200,1125 +207521,6 @@ "deprecated": true } }, - "/projects/{project_id}": { - "get": { - "summary": "Get 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": [ - "projects-classic" - ], - "operationId": "projects-classic/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#get-a-project" - }, - "parameters": [ - { - "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": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "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": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update 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.", - "operationId": "projects-classic/update", - "tags": [ - "projects-classic" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#update-a-project" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone.", - "type": "boolean" - } - }, - "type": "object" - }, - "examples": { - "default": { - "summary": "Change the name, state, and permissions for a project", - "value": { - "name": "Week One Sprint", - "state": "open", - "organization_permission": "write" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "404": { - "description": "Not Found if the authenticated user does not have access to the project" - }, - "304": { - "description": "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": { - "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete 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.", - "operationId": "projects-classic/delete", - "tags": [ - "projects-classic" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#delete-a-project" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Delete Success" - }, - "304": { - "description": "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": { - "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/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": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/projects/{project_id}/collaborators": { "get": { "summary": "List project collaborators", @@ -478399,1421 +477601,77 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pages", - "subcategory": "pages" - } - } - }, - "/repos/{owner}/{repo}/private-vulnerability-reporting": { - "get": { - "summary": "Check if private vulnerability reporting is enabled for a repository", - "description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".", - "tags": [ - "repos" - ], - "operationId": "repos/check-private-vulnerability-reporting", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-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": "Private vulnerability reporting status", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Whether or not private vulnerability reporting is enabled for the repository." - } - }, - "required": [ - "enabled" - ] - }, - "examples": { - "default": { - "value": { - "enabled": true - } - } - } - } - } - }, - "422": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" - } - }, - "put": { - "summary": "Enable private vulnerability reporting for a repository", - "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"", - "tags": [ - "repos" - ], - "operationId": "repos/enable-private-vulnerability-reporting", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-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": { - "204": { - "description": "A header with no content is returned." - }, - "422": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" - } - }, - "delete": { - "summary": "Disable private vulnerability reporting for a repository", - "description": "Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".", - "tags": [ - "repos" - ], - "operationId": "repos/disable-private-vulnerability-reporting", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-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": { - "204": { - "description": "A header with no content is returned." - }, - "422": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" - } - } - }, - "/repos/{owner}/{repo}/projects": { - "get": { - "summary": "List repository 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#list-repository-projects" - }, - "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" - } - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "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": "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create a repository 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#create-a-repository-project" - }, - "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": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the project." - }, - "body": { - "type": "string", - "description": "The description of the project." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "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": "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": "pages", + "subcategory": "pages" + } + } + }, + "/repos/{owner}/{repo}/private-vulnerability-reporting": { + "get": { + "summary": "Check if private vulnerability reporting is enabled for a repository", + "description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".", + "tags": [ + "repos" + ], + "operationId": "repos/check-private-vulnerability-reporting", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-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" + } }, - "410": { - "description": "Gone", + { + "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": "Private vulnerability reporting status", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether or not private vulnerability reporting is enabled for the repository." + } + }, + "required": [ + "enabled" + ] + }, + "examples": { + "default": { + "value": { + "enabled": true + } + } + } + } + } + }, + "422": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -479835,21 +477693,102 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + }, + "put": { + "summary": "Enable private vulnerability reporting for a repository", + "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"", + "tags": [ + "repos" + ], + "operationId": "repos/enable-private-vulnerability-reporting", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-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": { + "204": { + "description": "A header with no content is returned." }, "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "description": "Bad Request", "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -479857,7 +477796,49 @@ "documentation_url": { "type": "string" }, - "errors": { + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { "type": "array", "items": { "type": "string" @@ -479872,12 +477853,120 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" + "category": "repos", + "subcategory": "repos" + } + }, + "delete": { + "summary": "Disable private vulnerability reporting for a repository", + "description": "Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".", + "tags": [ + "repos" + ], + "operationId": "repos/disable-private-vulnerability-reporting", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository" }, - "deprecated": true + "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": { + "204": { + "description": "A header with no content is returned." + }, + "422": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } } }, "/repos/{owner}/{repo}/properties/values": { @@ -547179,8 +545268,12 @@ ] } }, - "required": [ - "state" + "anyOf": [ + { + "required": [ + "state" + ] + } ] }, "examples": { @@ -649247,498 +647340,6 @@ } } }, - "/user/projects": { - "post": { - "summary": "Create a user 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#create-a-user-project" - }, - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Create a new project", - "value": { - "name": "My Projects", - "body": "A board to manage my personal projects." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "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 Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/user/public_emails": { "get": { "summary": "List public email addresses for the authenticated user", @@ -686792,503 +684393,6 @@ } } }, - "/users/{username}/projects": { - "get": { - "summary": "List user 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#list-user-projects" - }, - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/users/{username}/projectsV2": { "get": { "summary": "List projects for user", @@ -714740,7 +711844,7 @@ }, "/users/{username}/settings/billing/usage/summary": { "get": { - "summary": "Get billing usage summary report for a user", + "summary": "Get billing usage summary for a user", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" @@ -714748,7 +711852,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-report-for-a-user" + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-for-a-user" }, "parameters": [ { @@ -714817,7 +711921,7 @@ ], "responses": { "200": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 4c00cbb86..c1b6b0f1a 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -1040,7 +1040,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &105 + schema: &106 title: Validation Error Simple description: Validation Error Simple type: object @@ -1073,7 +1073,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &611 + - &610 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1658,7 +1658,7 @@ paths: schema: type: integer default: 30 - - &183 + - &184 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1674,7 +1674,7 @@ paths: application/json: schema: type: array - items: &184 + items: &185 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1770,7 +1770,7 @@ paths: - installation_id - repository_id examples: - default: &185 + default: &186 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1833,7 +1833,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &104 + schema: &105 title: Validation Error description: Validation Error type: object @@ -1905,7 +1905,7 @@ paths: description: Response content: application/json: - schema: &186 + schema: &187 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -2040,7 +2040,7 @@ paths: - request - response examples: - default: &187 + default: &188 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -7736,7 +7736,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &161 + code_scanning_options: &162 type: - object - 'null' @@ -7934,7 +7934,7 @@ paths: description: Response content: application/json: - schema: &163 + schema: &164 type: array description: A list of default code security configurations items: @@ -7950,7 +7950,7 @@ paths: default configuration: *41 examples: - default: &164 + default: &165 value: - default_for_new_repos: public configuration: @@ -8281,7 +8281,7 @@ paths: - *40 - *43 responses: - '204': &165 + '204': &166 description: A header with no content is returned. '400': *14 '403': *27 @@ -8408,7 +8408,7 @@ paths: default: value: default_for_new_repos: all - configuration: &162 + configuration: &163 value: id: 1325 target_type: organization @@ -8493,7 +8493,7 @@ paths: application/json: schema: type: array - items: &166 + items: &167 type: object description: Repositories associated with a code security configuration and attachment status @@ -8838,7 +8838,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &167 + repository: &168 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -8932,7 +8932,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &170 + - &171 name: state in: query description: |- @@ -8941,7 +8941,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &171 + - &172 name: severity in: query description: |- @@ -8950,7 +8950,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &172 + - &173 name: ecosystem in: query description: |- @@ -8959,14 +8959,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &173 + - &174 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &174 + - &175 name: epss_percentage in: query description: |- @@ -8978,7 +8978,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &453 + - &451 name: has in: query description: |- @@ -8992,7 +8992,7 @@ paths: type: string enum: - patch - - &175 + - &176 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -9002,7 +9002,7 @@ paths: enum: - development - runtime - - &176 + - &177 name: sort in: query description: |- @@ -9028,11 +9028,11 @@ paths: application/json: schema: type: array - items: &177 + items: &178 type: object description: A Dependabot alert. properties: - number: &151 + number: &152 type: integer description: The security alert number. readOnly: true @@ -9098,7 +9098,7 @@ paths: - direct - transitive - - security_advisory: &454 + security_advisory: &452 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9305,29 +9305,29 @@ paths: - withdrawn_at additionalProperties: false security_vulnerability: *50 - url: &154 + url: &155 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &155 + html_url: &156 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &152 + created_at: &153 type: string description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &153 + updated_at: &154 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: &157 + dismissed_at: &158 type: - string - 'null' @@ -9358,7 +9358,7 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: &156 + fixed_at: &157 type: - string - 'null' @@ -9366,7 +9366,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &455 + auto_dismissed_at: &453 type: - string - 'null' @@ -9393,7 +9393,7 @@ paths: - repository additionalProperties: false examples: - default: &178 + default: &179 value: - number: 2 state: dismissed @@ -10978,7 +10978,7 @@ paths: timeline_url: type: string format: uri - type: &205 + type: &206 title: Issue Type description: The type of issue. type: @@ -11087,7 +11087,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &623 + sub_issues_summary: &622 title: Sub-issues Summary type: object properties: @@ -11108,7 +11108,7 @@ paths: - string - 'null' format: uri - issue_dependencies_summary: &624 + issue_dependencies_summary: &623 title: Issue Dependencies Summary type: object properties: @@ -11127,7 +11127,7 @@ paths: - total_blocking issue_field_values: type: array - items: &625 + items: &624 title: Issue Field Value description: A value assigned to an issue field type: object @@ -11222,7 +11222,7 @@ paths: - user - created_at - updated_at - comment: &501 + comment: &500 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -11800,7 +11800,7 @@ paths: url: type: string format: uri - user: &637 + user: &636 title: Public User description: Public User type: object @@ -13695,7 +13695,7 @@ paths: - closed - all default: open - - &208 + - &209 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -13746,7 +13746,7 @@ paths: type: array items: *78 examples: - default: &209 + default: &210 value: - id: 1 node_id: MDU6SXNzdWUx @@ -15227,7 +15227,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &317 + '301': &315 description: Moved permanently content: application/json: @@ -15249,7 +15249,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &530 + - &529 name: all description: If `true`, show notifications marked as read. in: query @@ -15257,7 +15257,7 @@ paths: schema: type: boolean default: false - - &531 + - &530 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -15267,7 +15267,7 @@ paths: type: boolean default: false - *68 - - &532 + - &531 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -15299,7 +15299,7 @@ paths: properties: id: type: string - repository: &135 + repository: &136 title: Minimal Repository description: Minimal Repository type: object @@ -15803,7 +15803,7 @@ paths: - url - subscription_url examples: - default: &533 + default: &532 value: - id: '1' repository: @@ -16682,7 +16682,7 @@ paths: - property_name - value examples: - default: &539 + default: &538 value: - property_name: environment value: production @@ -16732,7 +16732,7 @@ paths: required: - properties examples: - default: &540 + default: &539 value: properties: - property_name: environment @@ -16753,6 +16753,495 @@ paths: enabledForGitHubApps: true category: orgs subcategory: custom-properties-for-orgs + "/organizations/{org}/settings/billing/budgets": + get: + summary: Get all budgets for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-all-budgets-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#get-all-budgets-for-an-organization + parameters: + - *61 + responses: + '200': + description: Response when getting all budgets + content: + application/json: + schema: + type: object + properties: + budgets: + type: array + items: + type: object + properties: + id: + type: string + description: The unique identifier for the budget + examples: + - 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: + type: string + description: The type of pricing for the budget + enum: + - SkuPricing + - ProductPricing + examples: + - SkuPricing + budget_amount: + type: integer + description: The budget amount limit in whole dollars. For + license-based products, this represents the number of + licenses. + prevent_further_usage: + type: boolean + description: The type of limit enforcement for the budget + examples: + - true + budget_scope: + type: string + description: The scope of the budget (enterprise, organization, + repository, cost center) + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity for the budget (enterprise + does not require a name). + examples: + - octocat/hello-world + budget_product_sku: + type: string + description: A single product or sku to apply the budget + to. + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + examples: + - mona + - lisa + required: + - will_alert + - alert_recipients + required: + - id + - budget_type + - budget_product_sku + - budget_scope + - budget_amount + - prevent_further_usage + - budget_alerting + description: Array of budget objects for the enterprise + required: + - budgets + examples: + default: + value: + budgets: + - id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_skus: + - actions + budget_scope: enterprise + budget_amount: 1000.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - enterprise-admin + - billing-manager + - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 + budget_type: SkuPricing + budget_product_skus: + - actions_linux + budget_scope: organization + budget_amount: 500.0 + prevent_further_usage: false + budget_alerting: + will_alert: true + alert_recipients: + - org-owner + - id: 6ba7b810-9dad-11d1-80b4-00c04fd430c8 + budget_type: ProductPricing + budget_product_skus: + - packages + budget_scope: cost_center + budget_amount: 250.0 + prevent_further_usage: true + budget_alerting: + will_alert: false + alert_recipients: [] + '404': *6 + '403': *27 + '500': *96 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing + "/organizations/{org}/settings/billing/budgets/{budget_id}": + get: + summary: Get a budget by ID for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a budget by ID. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#get-a-budget-by-id-for-an-organization + parameters: + - *61 + - &98 + name: budget_id + description: The ID corresponding to the budget. + in: path + required: true + schema: + type: string + responses: + '200': + description: Response when updating a budget + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + enum: + - enterprise + - organization + - repository + - cost_center + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + examples: + - octocat/hello-world + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + examples: + - true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + examples: + - actions_linux + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + examples: + - ProductPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + examples: + - mona + - lisa + required: + - id + - budget_amount + - prevent_further_usage + - budget_product_sku + - budget_type + - budget_alerting + - budget_scope + - budget_entity_name + examples: + default: + value: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa + '400': *14 + '404': *6 + '403': *27 + '500': *96 + '503': *97 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing + patch: + summary: Update a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/update-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget-for-an-organization + parameters: + - *61 + - *98 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered in the + budget + examples: + update-budget: + summary: Update budget example + value: + prevent_further_usage: false + budget_amount: 10 + budget_alerting: + will_alert: false + alert_recipients: [] + responses: + '200': + description: Budget updated successfully + content: + application/json: + schema: + type: object + properties: + message: + type: string + examples: + - Budget successfully updated. + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_amount: + type: number + format: float + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the + budget is exceeded + budget_alerting: + type: object + required: + - will_alert + - alert_recipients + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + default: '' + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered + in the budget + examples: + update-budget: + value: + message: Budget successfully updated. + id: 550e8400-e29b-41d4-a716-446655440000 + '400': *14 + '401': *23 + '403': *27 + '404': + description: Budget not found or feature not enabled + content: + application/json: + schema: *3 + examples: + budget-not-found: + value: + message: Budget with ID 550e8400-e29b-41d4-a716-446655440000 not + found. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + feature-not-enabled: + value: + message: Not Found + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + '422': *15 + '500': + description: Internal server error + content: + application/json: + schema: *3 + examples: + server-error: + value: + message: Unable to update budget. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + delete: + summary: Delete a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/delete-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#delete-a-budget-for-an-organization + parameters: + - *61 + - *98 + 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': *14 + '404': *6 + '403': *27 + '500': *96 + '503': *97 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization @@ -16768,7 +17257,7 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-an-organization parameters: - *61 - - &98 + - &99 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, @@ -16777,7 +17266,7 @@ paths: required: false schema: type: integer - - &100 + - &101 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 @@ -16786,7 +17275,7 @@ paths: required: false schema: type: integer - - &99 + - &100 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 @@ -16801,14 +17290,14 @@ paths: required: false schema: type: string - - &680 + - &679 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &101 + - &102 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -16946,8 +17435,8 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - *61 - - *98 - - &683 + - *99 + - &682 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -16956,7 +17445,7 @@ paths: required: false schema: type: integer - - *99 + - *100 responses: '200': description: Billing usage report response for an organization @@ -17040,7 +17529,7 @@ paths: subcategory: enhanced-billing "/organizations/{org}/settings/billing/usage/summary": get: - summary: Get billing usage summary report for an organization + summary: Get billing usage summary for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. @@ -17053,21 +17542,21 @@ paths: operationId: billing/get-github-billing-usage-summary-report-org externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-report-for-an-organization + url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-for-an-organization parameters: - *61 - - *98 - - *100 - *99 - - &684 + - *101 + - *100 + - &683 name: repository description: The repository name to query for usage in the format owner/repository. in: query required: false schema: type: string - - *101 - - &685 + - *102 + - &684 name: sku description: The SKU to query for usage. in: query @@ -17076,7 +17565,7 @@ paths: type: string responses: '200': - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -17210,7 +17699,7 @@ paths: description: Response content: application/json: - schema: &102 + schema: &103 title: Organization Full description: Organization Full type: object @@ -17605,7 +18094,7 @@ paths: - updated_at - archived_at examples: - default-response: &103 + default-response: &104 value: login: github id: 1 @@ -17922,17 +18411,17 @@ paths: description: Response content: application/json: - schema: *102 + schema: *103 examples: - default: *103 + default: *104 '422': description: Validation failed content: application/json: schema: oneOf: - - *104 - *105 + - *106 '409': *45 x-github: githubCloudOnly: false @@ -18046,7 +18535,7 @@ paths: type: integer repository_cache_usages: type: array - items: &322 + items: &320 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -18122,7 +18611,7 @@ paths: type: integer runners: type: array - items: &106 + items: &107 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -18185,7 +18674,7 @@ paths: - size_gb - display_name - source - machine_size_details: &114 + machine_size_details: &115 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -18294,7 +18783,7 @@ paths: - public_ip_enabled - platform examples: - default: &134 + default: &135 value: total_count: 2 runners: @@ -18432,9 +18921,9 @@ paths: description: Response content: application/json: - schema: *106 + schema: *107 examples: - default: &115 + default: &116 value: id: 5 name: My hosted ubuntu runner @@ -18491,7 +18980,7 @@ paths: type: integer images: type: array - items: &107 + items: &108 title: GitHub-hosted runner custom image details description: Provides details of a custom runner image type: object @@ -18550,7 +19039,7 @@ paths: - latest_version - state examples: - default: &109 + default: &110 value: total_count: 2 image_versions: @@ -18582,7 +19071,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners parameters: - *61 - - &108 + - &109 name: image_definition_id description: Image definition ID of custom image in: path @@ -18594,7 +19083,7 @@ paths: description: Response content: application/json: - schema: *107 + schema: *108 examples: default: value: @@ -18625,7 +19114,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization parameters: - *61 - - *108 + - *109 responses: '204': description: Response @@ -18648,7 +19137,7 @@ 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: - - *108 + - *109 - *61 responses: '200': @@ -18665,7 +19154,7 @@ paths: type: integer image_versions: type: array - items: &110 + items: &111 title: GitHub-hosted runner custom image version details. description: Provides details of a hosted runner custom image version @@ -18703,7 +19192,7 @@ paths: - created_on - state_details examples: - default: *109 + default: *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18724,8 +19213,8 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners parameters: - *61 - - *108 - - &111 + - *109 + - &112 name: version description: Version of a custom image in: path @@ -18738,7 +19227,7 @@ paths: description: Response content: application/json: - schema: *110 + schema: *111 examples: default: value: @@ -18765,8 +19254,8 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization parameters: - *61 - - *108 - - *111 + - *109 + - *112 responses: '204': description: Response @@ -18803,7 +19292,7 @@ paths: type: integer images: type: array - items: &112 + items: &113 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -18843,7 +19332,7 @@ paths: - display_name - source examples: - default: &113 + default: &114 value: id: ubuntu-20.04 platform: linux-x64 @@ -18883,9 +19372,9 @@ paths: type: integer images: type: array - items: *112 + items: *113 examples: - default: *113 + default: *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18973,7 +19462,7 @@ paths: type: integer machine_specs: type: array - items: *114 + items: *115 examples: default: value: @@ -19043,7 +19532,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - *61 - - &116 + - &117 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -19055,9 +19544,9 @@ paths: description: Response content: application/json: - schema: *106 + schema: *107 examples: - default: *115 + default: *116 headers: Link: *52 x-github: @@ -19078,7 +19567,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - *61 - - *116 + - *117 requestBody: required: true content: @@ -19122,9 +19611,9 @@ paths: description: Response content: application/json: - schema: *106 + schema: *107 examples: - default: *115 + default: *116 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -19141,15 +19630,15 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - *61 - - *116 + - *117 responses: '202': description: Response content: application/json: - schema: *106 + schema: *107 examples: - default: *115 + default: *116 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -19175,7 +19664,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &117 + schema: &118 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -19189,7 +19678,7 @@ paths: required: - include_claim_keys examples: - default: &118 + default: &119 value: include_claim_keys: - repo @@ -19216,15 +19705,15 @@ paths: required: true content: application/json: - schema: *117 + schema: *118 examples: - default: *118 + default: *119 responses: '201': description: Empty response content: application/json: - schema: &144 + schema: &145 title: Empty Object description: An object without any properties. type: object @@ -19263,7 +19752,7 @@ paths: schema: type: object properties: - enabled_repositories: &119 + enabled_repositories: &120 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -19276,7 +19765,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: &120 + allowed_actions: &121 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -19284,12 +19773,12 @@ paths: - all - local_only - selected - selected_actions_url: &328 + selected_actions_url: &326 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: &121 + sha_pinning_required: &122 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -19331,9 +19820,9 @@ paths: schema: type: object properties: - enabled_repositories: *119 - allowed_actions: *120 - sha_pinning_required: *121 + enabled_repositories: *120 + allowed_actions: *121 + sha_pinning_required: *122 required: - enabled_repositories examples: @@ -19367,7 +19856,7 @@ paths: description: Response content: application/json: - schema: &332 + schema: &330 type: object properties: days: @@ -19409,7 +19898,7 @@ paths: required: true content: application/json: - schema: &333 + schema: &331 type: object properties: days: @@ -19452,7 +19941,7 @@ paths: description: Response content: application/json: - schema: &122 + schema: &123 type: object properties: approval_policy: @@ -19466,7 +19955,7 @@ paths: required: - approval_policy examples: - default: &334 + default: &332 value: approval_policy: first_time_contributors '404': *6 @@ -19497,7 +19986,7 @@ paths: required: true content: application/json: - schema: *122 + schema: *123 examples: default: summary: Set approval policy to first time contributors @@ -19525,7 +20014,7 @@ paths: description: Response content: application/json: - schema: &335 + schema: &333 type: object required: - run_workflows_from_fork_pull_requests @@ -19551,7 +20040,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &123 + default: &124 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -19579,7 +20068,7 @@ paths: required: true content: application/json: - schema: &336 + schema: &334 type: object required: - run_workflows_from_fork_pull_requests @@ -19602,7 +20091,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *123 + default: *124 responses: '204': description: Empty response for successful settings update @@ -19652,7 +20141,7 @@ paths: type: array items: *64 examples: - default: &127 + default: &128 value: total_count: 1 repositories: @@ -19837,7 +20326,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *61 - - &124 + - &125 name: repository_id description: The unique identifier of the repository. in: path @@ -19866,7 +20355,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *61 - - *124 + - *125 responses: '204': description: Response @@ -19895,7 +20384,7 @@ paths: description: Response content: application/json: - schema: &125 + schema: &126 type: object properties: github_owned_allowed: @@ -19917,7 +20406,7 @@ paths: items: type: string examples: - default: &126 + default: &127 value: github_owned_allowed: true verified_allowed: false @@ -19950,9 +20439,9 @@ paths: required: false content: application/json: - schema: *125 + schema: *126 examples: - selected_actions: *126 + selected_actions: *127 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -20084,7 +20573,7 @@ paths: type: array items: *64 examples: - default: *127 + default: *128 '403': *27 '404': *6 x-github: @@ -20153,7 +20642,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - *61 - - *124 + - *125 responses: '204': description: No content @@ -20180,7 +20669,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - *61 - - *124 + - *125 responses: '204': description: No content @@ -20214,17 +20703,17 @@ paths: description: Response content: application/json: - schema: &337 + schema: &335 type: object properties: - default_workflow_permissions: &128 + default_workflow_permissions: &129 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &129 + can_approve_pull_request_reviews: &130 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -20232,7 +20721,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &130 + default: &131 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -20265,13 +20754,13 @@ paths: required: false content: application/json: - schema: &338 + schema: &336 type: object properties: - default_workflow_permissions: *128 - can_approve_pull_request_reviews: *129 + default_workflow_permissions: *129 + can_approve_pull_request_reviews: *130 examples: - default: *130 + default: *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20316,7 +20805,7 @@ paths: type: number runner_groups: type: array - items: &131 + items: &132 type: object properties: id: @@ -20506,9 +20995,9 @@ paths: description: Response content: application/json: - schema: *131 + schema: *132 examples: - default: &133 + default: &134 value: id: 2 name: octo-runner-group @@ -20544,7 +21033,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - *61 - - &132 + - &133 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -20556,7 +21045,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *132 examples: default: value: @@ -20593,7 +21082,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - *61 - - *132 + - *133 requestBody: required: true content: @@ -20649,9 +21138,9 @@ paths: description: Response content: application/json: - schema: *131 + schema: *132 examples: - default: *133 + default: *134 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -20671,7 +21160,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - *61 - - *132 + - *133 responses: '204': description: Response @@ -20695,7 +21184,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - *61 - - *132 + - *133 - *17 - *19 responses: @@ -20713,9 +21202,9 @@ paths: type: number runners: type: array - items: *106 + items: *107 examples: - default: *134 + default: *135 headers: Link: *52 x-github: @@ -20738,7 +21227,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *61 - - *132 + - *133 - *19 - *17 responses: @@ -20756,9 +21245,9 @@ paths: type: number repositories: type: array - items: *135 + items: *136 examples: - default: &640 + default: &639 value: total_count: 1 repositories: @@ -21011,7 +21500,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - *61 - - *132 + - *133 requestBody: required: true content: @@ -21056,8 +21545,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *61 - - *132 - - *124 + - *133 + - *125 responses: '204': description: Response @@ -21080,8 +21569,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *61 - - *132 - - *124 + - *133 + - *125 responses: '204': description: Response @@ -21105,7 +21594,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - *61 - - *132 + - *133 - *17 - *19 responses: @@ -21123,7 +21612,7 @@ paths: type: number runners: type: array - items: &137 + items: &138 title: Self hosted runners description: A self hosted runner type: object @@ -21157,7 +21646,7 @@ paths: type: boolean labels: type: array - items: &140 + items: &141 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -21187,7 +21676,7 @@ paths: - busy - labels examples: - default: &138 + default: &139 value: total_count: 2 runners: @@ -21247,7 +21736,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - *61 - - *132 + - *133 requestBody: required: true content: @@ -21292,8 +21781,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - *61 - - *132 - - &136 + - *133 + - &137 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -21322,8 +21811,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - *61 - - *132 - - *136 + - *133 + - *137 responses: '204': description: Response @@ -21371,9 +21860,9 @@ paths: type: integer runners: type: array - items: *137 + items: *138 examples: - default: *138 + default: *139 headers: Link: *52 x-github: @@ -21405,7 +21894,7 @@ paths: application/json: schema: type: array - items: &339 + items: &337 title: Runner Application description: Runner Application type: object @@ -21430,7 +21919,7 @@ paths: - download_url - filename examples: - default: &340 + default: &338 value: - os: osx architecture: x64 @@ -21516,7 +22005,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &341 + '201': &339 description: Response content: application/json: @@ -21526,7 +22015,7 @@ paths: - runner - encoded_jit_config properties: - runner: *137 + runner: *138 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -21589,7 +22078,7 @@ paths: description: Response content: application/json: - schema: &139 + schema: &140 title: Authentication Token description: Authentication Token type: object @@ -21631,7 +22120,7 @@ paths: - token - expires_at examples: - default: &342 + default: &340 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -21668,9 +22157,9 @@ paths: description: Response content: application/json: - schema: *139 + schema: *140 examples: - default: &343 + default: &341 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -21696,15 +22185,15 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - *61 - - *136 + - *137 responses: '200': description: Response content: application/json: - schema: *137 + schema: *138 examples: - default: &344 + default: &342 value: id: 23 name: MBP @@ -21746,7 +22235,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - *61 - - *136 + - *137 responses: '204': description: Response @@ -21773,9 +22262,9 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - *61 - - *136 + - *137 responses: - '200': &141 + '200': &142 description: Response content: application/json: @@ -21789,7 +22278,7 @@ paths: type: integer labels: type: array - items: *140 + items: *141 examples: default: value: @@ -21829,7 +22318,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - *61 - - *136 + - *137 requestBody: required: true content: @@ -21853,7 +22342,7 @@ paths: - gpu - accelerated responses: - '200': *141 + '200': *142 '404': *6 '422': *7 x-github: @@ -21878,7 +22367,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - *61 - - *136 + - *137 requestBody: required: true content: @@ -21903,7 +22392,7 @@ paths: - gpu - accelerated responses: - '200': *141 + '200': *142 '404': *6 '422': *7 x-github: @@ -21928,9 +22417,9 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - *61 - - *136 + - *137 responses: - '200': &345 + '200': &343 description: Response content: application/json: @@ -21944,7 +22433,7 @@ paths: type: integer labels: type: array - items: *140 + items: *141 examples: default: value: @@ -21986,8 +22475,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - *61 - - *136 - - &346 + - *137 + - &344 name: name description: The name of a self-hosted runner's custom label. in: path @@ -21995,7 +22484,7 @@ paths: schema: type: string responses: - '200': *141 + '200': *142 '404': *6 '422': *7 x-github: @@ -22038,7 +22527,7 @@ paths: type: integer secrets: type: array - items: &142 + items: &143 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -22119,7 +22608,7 @@ paths: description: Response content: application/json: - schema: &358 + schema: &356 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -22154,7 +22643,7 @@ paths: - key_id - key examples: - default: &359 + default: &357 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -22180,7 +22669,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - *61 - - &143 + - &144 name: secret_name description: The name of the secret. in: path @@ -22192,7 +22681,7 @@ paths: description: Response content: application/json: - schema: *142 + schema: *143 examples: default: value: @@ -22223,7 +22712,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - *61 - - *143 + - *144 requestBody: required: true content: @@ -22280,7 +22769,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -22307,7 +22796,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - *61 - - *143 + - *144 responses: '204': description: Response @@ -22334,7 +22823,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - *61 - - *143 + - *144 - *19 - *17 responses: @@ -22352,9 +22841,9 @@ paths: type: integer repositories: type: array - items: *135 + items: *136 examples: - default: &147 + default: &148 value: total_count: 1 repositories: @@ -22447,7 +22936,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - *61 - - *143 + - *144 requestBody: required: true content: @@ -22500,7 +22989,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - *61 - - *143 + - *144 - name: repository_id in: path required: true @@ -22534,7 +23023,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - *61 - - *143 + - *144 - name: repository_id in: path required: true @@ -22567,7 +23056,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *61 - - &327 + - &325 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)." @@ -22591,7 +23080,7 @@ paths: type: integer variables: type: array - items: &145 + items: &146 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -22729,7 +23218,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -22755,7 +23244,7 @@ paths: url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - *61 - - &146 + - &147 name: name description: The name of the variable. in: path @@ -22767,7 +23256,7 @@ paths: description: Response content: application/json: - schema: *145 + schema: *146 examples: default: value: @@ -22798,7 +23287,7 @@ paths: url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - *61 - - *146 + - *147 requestBody: required: true content: @@ -22861,7 +23350,7 @@ paths: url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - *61 - - *146 + - *147 responses: '204': description: Response @@ -22888,7 +23377,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - *61 - - *146 + - *147 - *19 - *17 responses: @@ -22906,9 +23395,9 @@ paths: type: integer repositories: type: array - items: *135 + items: *136 examples: - default: *147 + default: *148 '409': description: Response when the visibility of the variable is not set to `selected` @@ -22935,7 +23424,7 @@ paths: url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - *61 - - *146 + - *147 requestBody: required: true content: @@ -22985,7 +23474,7 @@ paths: url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - *61 - - *146 + - *147 - name: repository_id in: path required: true @@ -23020,7 +23509,7 @@ paths: url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - *61 - - *146 + - *147 - name: repository_id in: path required: true @@ -23317,12 +23806,12 @@ paths: required: - subject_digests examples: - default: &667 + default: &666 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &668 + withPredicateType: &667 value: subject_digests: - sha256:abc123 @@ -23381,7 +23870,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &669 + default: &668 value: attestations_subject_digests: - sha256:abc: @@ -23730,7 +24219,7 @@ paths: initiator: type: string examples: - default: &372 + default: &370 value: attestations: - bundle: @@ -23949,7 +24438,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &148 + schema: &149 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -23975,7 +24464,7 @@ paths: application/json: schema: type: array - items: &149 + items: &150 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -24006,7 +24495,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &169 + items: &170 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -24083,7 +24572,7 @@ paths: parent: anyOf: - type: 'null' - - &220 + - &221 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -24219,7 +24708,7 @@ paths: - string - 'null' format: date-time - state: *148 + state: *149 contact_link: description: The contact link of the campaign. type: @@ -24442,9 +24931,9 @@ paths: description: Response content: application/json: - schema: *149 + schema: *150 examples: - default: &150 + default: &151 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -24527,9 +25016,9 @@ paths: description: Response content: application/json: - schema: *149 + schema: *150 examples: - default: *150 + default: *151 '404': *6 '422': description: Unprocessable Entity @@ -24607,7 +25096,7 @@ paths: - string - 'null' format: uri - state: *148 + state: *149 examples: default: value: @@ -24617,9 +25106,9 @@ paths: description: Response content: application/json: - schema: *149 + schema: *150 examples: - default: *150 + default: *151 '400': description: Bad Request content: @@ -24686,17 +25175,17 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *61 - - &397 + - &395 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: &158 + schema: &159 type: string description: The name of the tool used to generate the code scanning analysis. - - &398 + - &396 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 @@ -24704,7 +25193,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &159 + schema: &160 type: - string - 'null' @@ -24720,7 +25209,7 @@ paths: be returned. in: query required: false - schema: &400 + schema: &398 type: string description: State of a code scanning alert. enum: @@ -24743,7 +25232,7 @@ paths: be returned. in: query required: false - schema: &401 + schema: &399 type: string description: Severity of a code scanning alert. enum: @@ -24764,18 +25253,18 @@ paths: items: type: object properties: - number: *151 - created_at: *152 - updated_at: *153 - url: *154 - html_url: *155 - instances_url: &402 + number: *152 + created_at: *153 + updated_at: *154 + url: *155 + html_url: *156 + instances_url: &400 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &160 + state: &161 type: - string - 'null' @@ -24785,13 +25274,13 @@ paths: - dismissed - fixed - - fixed_at: *156 + fixed_at: *157 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *157 - dismissed_reason: &403 + dismissed_at: *158 + dismissed_reason: &401 type: - string - 'null' @@ -24802,14 +25291,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &404 + dismissed_comment: &402 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &405 + rule: &403 type: object properties: id: @@ -24870,26 +25359,26 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &406 + tool: &404 type: object properties: - name: *158 + name: *159 version: type: - string - 'null' description: The version of the tool used to generate the code scanning analysis. - guid: *159 - most_recent_instance: &407 + guid: *160 + most_recent_instance: &405 type: object properties: - ref: &399 + ref: &397 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &417 + analysis_key: &415 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -24900,13 +25389,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &418 + category: &416 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: *160 + state: *161 commit_sha: type: string message: @@ -25412,7 +25901,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *161 + code_scanning_options: *162 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -25555,7 +26044,7 @@ paths: application/json: schema: *41 examples: - default: *162 + default: *163 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25583,9 +26072,9 @@ paths: description: Response content: application/json: - schema: *163 + schema: *164 examples: - default: *164 + default: *165 '304': *35 '403': *27 '404': *6 @@ -25637,7 +26126,7 @@ paths: - 32 - 91 responses: - '204': *165 + '204': *166 '400': *14 '403': *27 '404': *6 @@ -25672,7 +26161,7 @@ paths: application/json: schema: *41 examples: - default: *162 + default: *163 '304': *35 '403': *27 '404': *6 @@ -25956,7 +26445,7 @@ paths: - *61 - *43 responses: - '204': *165 + '204': *166 '400': *14 '403': *27 '404': *6 @@ -26094,7 +26583,7 @@ paths: default: value: default_for_new_repos: all - configuration: *162 + configuration: *163 '403': *27 '404': *6 x-github: @@ -26147,13 +26636,13 @@ paths: application/json: schema: type: array - items: *166 + items: *167 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *167 + repository: *168 '403': *27 '404': *6 x-github: @@ -26193,7 +26682,7 @@ paths: type: integer codespaces: type: array - items: &210 + items: &211 type: object title: Codespace description: A codespace. @@ -26224,11 +26713,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *135 + repository: *136 machine: anyOf: - type: 'null' - - &430 + - &428 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -26515,7 +27004,7 @@ paths: - pulls_url - recent_folders examples: - default: &211 + default: &212 value: total_count: 3 codespaces: @@ -27139,7 +27628,7 @@ paths: type: integer secrets: type: array - items: &168 + items: &169 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -27180,7 +27669,7 @@ paths: - updated_at - visibility examples: - default: &431 + default: &429 value: total_count: 2 secrets: @@ -27218,7 +27707,7 @@ paths: description: Response content: application/json: - schema: &432 + schema: &430 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -27253,7 +27742,7 @@ paths: - key_id - key examples: - default: &433 + default: &431 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -27277,15 +27766,15 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - *61 - - *143 + - *144 responses: '200': description: Response content: application/json: - schema: *168 + schema: *169 examples: - default: &435 + default: &433 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -27313,7 +27802,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - *61 - - *143 + - *144 requestBody: required: true content: @@ -27368,7 +27857,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -27395,7 +27884,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - *61 - - *143 + - *144 responses: '204': description: Response @@ -27421,7 +27910,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - *61 - - *143 + - *144 - *19 - *17 responses: @@ -27439,9 +27928,9 @@ paths: type: integer repositories: type: array - items: *135 + items: *136 examples: - default: *147 + default: *148 '404': *6 x-github: githubCloudOnly: false @@ -27464,7 +27953,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - *61 - - *143 + - *144 requestBody: required: true content: @@ -27515,7 +28004,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - *61 - - *143 + - *144 - name: repository_id in: path required: true @@ -27549,7 +28038,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - *61 - - *143 + - *144 - name: repository_id in: path required: true @@ -27752,7 +28241,7 @@ paths: currently being billed. seats: type: array - items: &213 + items: &214 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -27770,7 +28259,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *169 + - *170 - *53 type: - 'null' @@ -28728,11 +29217,11 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *61 - - *170 - *171 - *172 - *173 - *174 + - *175 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -28770,8 +29259,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *175 - *176 + - *177 - *46 - *38 - *39 @@ -28783,9 +29272,9 @@ paths: application/json: schema: type: array - items: *177 + items: *178 examples: - default: *178 + default: *179 '304': *35 '400': *14 '403': *27 @@ -28829,7 +29318,7 @@ paths: type: integer secrets: type: array - items: &179 + items: &180 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -28908,7 +29397,7 @@ paths: description: Response content: application/json: - schema: &458 + schema: &456 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -28927,7 +29416,7 @@ paths: - key_id - key examples: - default: &459 + default: &457 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -28951,13 +29440,13 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - *61 - - *143 + - *144 responses: '200': description: Response content: application/json: - schema: *179 + schema: *180 examples: default: value: @@ -28986,7 +29475,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - *61 - - *143 + - *144 requestBody: required: true content: @@ -29045,7 +29534,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -29070,7 +29559,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - *61 - - *143 + - *144 responses: '204': description: Response @@ -29095,7 +29584,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - *61 - - *143 + - *144 - *19 - *17 responses: @@ -29113,9 +29602,9 @@ paths: type: integer repositories: type: array - items: *135 + items: *136 examples: - default: *147 + default: *148 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29137,7 +29626,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - *61 - - *143 + - *144 requestBody: required: true content: @@ -29188,7 +29677,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - *61 - - *143 + - *144 - name: repository_id in: path required: true @@ -29220,7 +29709,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - *61 - - *143 + - *144 - name: repository_id in: path required: true @@ -29258,7 +29747,7 @@ paths: application/json: schema: type: array - items: &222 + items: &223 title: Package description: A software package type: object @@ -29311,7 +29800,7 @@ paths: repository: anyOf: - type: 'null' - - *135 + - *136 created_at: type: string format: date-time @@ -29329,7 +29818,7 @@ paths: - created_at - updated_at examples: - default: &223 + default: &224 value: - id: 197 name: hello_docker @@ -29499,7 +29988,7 @@ paths: application/json: schema: type: array - items: &202 + items: &203 title: Organization Invitation description: Organization Invitation type: object @@ -29553,7 +30042,7 @@ paths: - invitation_teams_url - node_id examples: - default: &203 + default: &204 value: - id: 1 login: monalisa @@ -29620,7 +30109,7 @@ paths: application/json: schema: type: array - items: &180 + items: &181 title: Org Hook description: Org Hook type: object @@ -29805,9 +30294,9 @@ paths: description: Response content: application/json: - schema: *180 + schema: *181 examples: - default: &181 + default: &182 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -29855,7 +30344,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - *61 - - &182 + - &183 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. @@ -29868,9 +30357,9 @@ paths: description: Response content: application/json: - schema: *180 + schema: *181 examples: - default: *181 + default: *182 '404': *6 x-github: githubCloudOnly: false @@ -29898,7 +30387,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - *61 - - *182 + - *183 requestBody: required: false content: @@ -29944,7 +30433,7 @@ paths: description: Response content: application/json: - schema: *180 + schema: *181 examples: default: value: @@ -29986,7 +30475,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - *61 - - *182 + - *183 responses: '204': description: Response @@ -30014,7 +30503,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *61 - - *182 + - *183 responses: '200': description: Response @@ -30045,7 +30534,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *61 - - *182 + - *183 requestBody: required: false content: @@ -30096,9 +30585,9 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *61 - - *182 - - *17 - *183 + - *17 + - *184 responses: '200': description: Response @@ -30106,9 +30595,9 @@ paths: application/json: schema: type: array - items: *184 + items: *185 examples: - default: *185 + default: *186 '400': *14 '422': *15 x-github: @@ -30134,16 +30623,16 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *61 - - *182 + - *183 - *16 responses: '200': description: Response content: application/json: - schema: *186 + schema: *187 examples: - default: *187 + default: *188 '400': *14 '422': *15 x-github: @@ -30169,7 +30658,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *61 - - *182 + - *183 - *16 responses: '202': *37 @@ -30199,7 +30688,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - *61 - - *182 + - *183 responses: '204': description: Response @@ -30222,7 +30711,7 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - *61 - - &192 + - &193 name: actor_type in: path description: The type of the actor @@ -30235,14 +30724,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &193 + - &194 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &188 + - &189 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`.' @@ -30250,7 +30739,7 @@ paths: required: true schema: type: string - - &189 + - &190 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) @@ -30345,12 +30834,12 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - *61 - - *188 - *189 + - *190 - *19 - *17 - *46 - - &198 + - &199 name: sort description: The property to sort the results by. in: query @@ -30430,14 +30919,14 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - *61 - - *188 - *189 + - *190 responses: '200': description: Response content: application/json: - schema: &190 + schema: &191 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -30453,7 +30942,7 @@ paths: type: integer format: int64 examples: - default: &191 + default: &192 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -30474,23 +30963,23 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - *61 - - &194 + - &195 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *188 - *189 + - *190 responses: '200': description: Response content: application/json: - schema: *190 + schema: *191 examples: - default: *191 + default: *192 x-github: enabledForGitHubApps: true category: orgs @@ -30509,18 +30998,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *61 - - *188 - *189 - - *192 + - *190 - *193 + - *194 responses: '200': description: Response content: application/json: - schema: *190 + schema: *191 examples: - default: *191 + default: *192 x-github: enabledForGitHubApps: true category: orgs @@ -30538,9 +31027,9 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - *61 - - *188 - *189 - - &195 + - *190 + - &196 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -30553,7 +31042,7 @@ paths: description: Response content: application/json: - schema: &196 + schema: &197 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -30569,7 +31058,7 @@ paths: type: integer format: int64 examples: - default: &197 + default: &198 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -30606,18 +31095,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - *61 - - *194 - - *188 - - *189 - *195 + - *189 + - *190 + - *196 responses: '200': description: Response content: application/json: - schema: *196 + schema: *197 examples: - default: *197 + default: *198 x-github: enabledForGitHubApps: true category: orgs @@ -30635,19 +31124,19 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - *61 - - *192 - *193 - - *188 + - *194 - *189 - - *195 + - *190 + - *196 responses: '200': description: Response content: application/json: - schema: *196 + schema: *197 examples: - default: *197 + default: *198 x-github: enabledForGitHubApps: true category: orgs @@ -30665,13 +31154,13 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - *61 - - *194 - - *188 + - *195 - *189 + - *190 - *19 - *17 - *46 - - *198 + - *199 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -30755,7 +31244,7 @@ paths: application/json: schema: *20 examples: - default: &497 + default: &495 value: id: 1 account: @@ -30921,12 +31410,12 @@ paths: application/json: schema: anyOf: - - &200 + - &201 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &199 + limit: &200 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -30954,7 +31443,7 @@ paths: properties: {} additionalProperties: false examples: - default: &201 + default: &202 value: limit: collaborators_only origin: organization @@ -30983,13 +31472,13 @@ paths: required: true content: application/json: - schema: &498 + schema: &496 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *199 + limit: *200 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -31014,9 +31503,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *201 examples: - default: *201 + default: *202 '422': *15 x-github: githubCloudOnly: false @@ -31092,9 +31581,9 @@ paths: application/json: schema: type: array - items: *202 + items: *203 examples: - default: *203 + default: *204 headers: Link: *52 '404': *6 @@ -31171,7 +31660,7 @@ paths: description: Response content: application/json: - schema: *202 + schema: *203 examples: default: value: @@ -31226,7 +31715,7 @@ paths: url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - *61 - - &204 + - &205 name: invitation_id description: The unique identifier of the invitation. in: path @@ -31257,7 +31746,7 @@ paths: url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - *61 - - *204 + - *205 - *17 - *19 responses: @@ -31267,9 +31756,9 @@ paths: application/json: schema: type: array - items: *169 + items: *170 examples: - default: &221 + default: &222 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -31312,7 +31801,7 @@ paths: application/json: schema: type: array - items: *205 + items: *206 examples: default: value: @@ -31400,9 +31889,9 @@ paths: description: Response content: application/json: - schema: *205 + schema: *206 examples: - default: &206 + default: &207 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -31435,7 +31924,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *61 - - &207 + - &208 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -31491,9 +31980,9 @@ paths: description: Response content: application/json: - schema: *205 + schema: *206 examples: - default: *206 + default: *207 '404': *6 '422': *7 x-github: @@ -31518,7 +32007,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *61 - - *207 + - *208 responses: '204': description: Response @@ -31581,7 +32070,7 @@ paths: - closed - all default: open - - *208 + - *209 - name: type description: Can be the name of an issue type. in: query @@ -31612,7 +32101,7 @@ paths: type: array items: *78 examples: - default: *209 + default: *210 headers: Link: *52 '404': *6 @@ -31771,9 +32260,9 @@ paths: type: integer codespaces: type: array - items: *210 + items: *211 examples: - default: *211 + default: *212 '304': *35 '500': *96 '401': *23 @@ -31800,7 +32289,7 @@ paths: parameters: - *61 - *57 - - &212 + - &213 name: codespace_name in: path required: true @@ -31835,15 +32324,15 @@ paths: parameters: - *61 - *57 - - *212 + - *213 responses: '200': description: Response content: application/json: - schema: *210 + schema: *211 examples: - default: &429 + default: &427 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -32023,7 +32512,7 @@ paths: description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *213 + schema: *214 examples: default: value: @@ -32099,7 +32588,7 @@ paths: description: Response content: application/json: - schema: &214 + schema: &215 title: Org Membership description: Org Membership type: object @@ -32168,7 +32657,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &215 + response-if-user-has-an-active-admin-membership-with-organization: &216 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -32265,9 +32754,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *215 examples: - response-if-user-already-had-membership-with-organization: *215 + response-if-user-already-had-membership-with-organization: *216 '422': *15 '403': *27 x-github: @@ -32339,7 +32828,7 @@ paths: application/json: schema: type: array - items: &216 + items: &217 title: Migration description: A migration. type: object @@ -32677,7 +33166,7 @@ paths: description: Response content: application/json: - schema: *216 + schema: *217 examples: default: value: @@ -32856,7 +33345,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - *61 - - &217 + - &218 name: migration_id description: The unique identifier of the migration. in: path @@ -32884,7 +33373,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *216 + schema: *217 examples: default: value: @@ -33054,7 +33543,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - *61 - - *217 + - *218 responses: '302': description: Response @@ -33076,7 +33565,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *61 - - *217 + - *218 responses: '204': description: Response @@ -33100,8 +33589,8 @@ paths: url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - *61 - - *217 - - &652 + - *218 + - &651 name: repo_name description: repo_name parameter in: path @@ -33129,7 +33618,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *61 - - *217 + - *218 - *17 - *19 responses: @@ -33139,9 +33628,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: &228 + default: &229 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -33294,7 +33783,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &219 + items: &220 title: Organization Role description: Organization roles type: object @@ -33471,7 +33960,7 @@ paths: parameters: - *61 - *62 - - &218 + - &219 name: role_id description: The unique identifier of the role. in: path @@ -33508,7 +33997,7 @@ paths: parameters: - *61 - *62 - - *218 + - *219 responses: '204': description: Response @@ -33561,7 +34050,7 @@ paths: parameters: - *61 - *57 - - *218 + - *219 responses: '204': description: Response @@ -33593,7 +34082,7 @@ paths: parameters: - *61 - *57 - - *218 + - *219 responses: '204': description: Response @@ -33622,13 +34111,13 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - *61 - - *218 + - *219 responses: '200': description: Response content: application/json: - schema: *219 + schema: *220 examples: default: value: @@ -33679,7 +34168,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - *61 - - *218 + - *219 - *17 - *19 responses: @@ -33758,7 +34247,7 @@ paths: parent: anyOf: - type: 'null' - - *220 + - *221 type: description: The ownership type of the team type: string @@ -33791,7 +34280,7 @@ paths: - type - parent examples: - default: *221 + default: *222 headers: Link: *52 '404': @@ -33821,7 +34310,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - *61 - - *218 + - *219 - *17 - *19 responses: @@ -33850,7 +34339,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *220 + items: *221 name: type: - string @@ -34160,7 +34649,7 @@ paths: - nuget - container - *61 - - &653 + - &652 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -34196,12 +34685,12 @@ paths: application/json: schema: type: array - items: *222 + items: *223 examples: - default: *223 + default: *224 '403': *27 '401': *23 - '400': &655 + '400': &654 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -34223,7 +34712,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &224 + - &225 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 @@ -34241,7 +34730,7 @@ paths: - docker - nuget - container - - &225 + - &226 name: package_name description: The name of the package. in: path @@ -34254,7 +34743,7 @@ paths: description: Response content: application/json: - schema: *222 + schema: *223 examples: default: value: @@ -34306,8 +34795,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *224 - *225 + - *226 - *61 responses: '204': @@ -34340,8 +34829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *224 - *225 + - *226 - *61 - name: token description: package token @@ -34374,8 +34863,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *224 - *225 + - *226 - *61 - *19 - *17 @@ -34396,7 +34885,7 @@ paths: application/json: schema: type: array - items: &226 + items: &227 title: Package Version description: A version of a software package type: object @@ -34531,10 +35020,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *224 - *225 + - *226 - *61 - - &227 + - &228 name: package_version_id description: Unique identifier of the package version. in: path @@ -34546,7 +35035,7 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: default: value: @@ -34582,10 +35071,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *224 - *225 + - *226 - *61 - - *227 + - *228 responses: '204': description: Response @@ -34617,10 +35106,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *224 - *225 + - *226 - *61 - - *227 + - *228 responses: '204': description: Response @@ -34650,7 +35139,7 @@ paths: - *61 - *17 - *19 - - &229 + - &230 name: sort description: The property by which to sort the results. in: query @@ -34661,7 +35150,7 @@ paths: - created_at default: created_at - *46 - - &230 + - &231 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -34673,7 +35162,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &231 + - &232 name: repository description: The name of the repository to use to filter the results. in: query @@ -34682,7 +35171,7 @@ paths: type: string examples: - Hello-World - - &232 + - &233 name: permission description: The permission to use to filter the results. in: query @@ -34691,7 +35180,7 @@ paths: type: string examples: - issues_read - - &233 + - &234 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) @@ -34701,7 +35190,7 @@ paths: schema: type: string format: date-time - - &234 + - &235 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) @@ -34711,7 +35200,7 @@ paths: schema: type: string format: date-time - - &235 + - &236 name: token_id description: The ID of the token in: query @@ -34987,7 +35476,7 @@ paths: '422': *15 '404': *6 '403': *27 - '204': *165 + '204': *166 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35028,9 +35517,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: *228 + default: *229 headers: Link: *52 x-github: @@ -35056,14 +35545,14 @@ paths: - *61 - *17 - *19 - - *229 - - *46 - *230 + - *46 - *231 - *232 - *233 - *234 - *235 + - *236 responses: '500': *96 '422': *15 @@ -35304,7 +35793,7 @@ paths: responses: '500': *96 '404': *6 - '204': *165 + '204': *166 '403': *27 '422': *15 x-github: @@ -35345,9 +35834,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: *228 + default: *229 headers: Link: *52 x-github: @@ -35389,7 +35878,7 @@ paths: type: integer configurations: type: array - items: &236 + items: &237 title: Organization private registry description: Private registry configuration for an organization type: object @@ -35685,7 +36174,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &237 + org-private-registry-with-selected-visibility: &238 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -35777,15 +36266,15 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - *61 - - *143 + - *144 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *236 + schema: *237 examples: - default: *237 + default: *238 '404': *6 x-github: githubCloudOnly: false @@ -35807,7 +36296,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - *61 - - *143 + - *144 requestBody: required: true content: @@ -35913,7 +36402,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - *61 - - *143 + - *144 responses: '204': description: Response @@ -35924,275 +36413,6 @@ paths: enabledForGitHubApps: true category: private-registries subcategory: organization-configurations - "/orgs/{org}/projects": - get: - summary: List organization 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: - - projects-classic - operationId: projects-classic/list-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#list-organization-projects - parameters: - - *61 - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &238 - title: Project - description: Projects are a way to organize columns and cards of - work. - type: object - properties: - owner_url: - type: string - format: uri - examples: - - https://api.github.com/repos/api-playground/projects-test - url: - type: string - format: uri - examples: - - https://api.github.com/projects/1002604 - html_url: - type: string - format: uri - examples: - - https://github.com/api-playground/projects-test/projects/12 - columns_url: - type: string - format: uri - examples: - - https://api.github.com/projects/1002604/columns - id: - type: integer - examples: - - 1002604 - node_id: - type: string - examples: - - MDc6UHJvamVjdDEwMDI2MDQ= - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - number: - type: integer - examples: - - 1 - state: - description: State of the project; either 'open' or 'closed' - type: string - examples: - - open - creator: - anyOf: - - type: 'null' - - *4 - created_at: - type: string - format: date-time - examples: - - '2011-04-10T20:09:31Z' - updated_at: - type: string - format: date-time - examples: - - '2014-03-03T18:58:10Z' - organization_permission: - description: The baseline permission that all organization members - have on this project. Only present if owner is an organization. - type: string - enum: - - read - - write - - admin - - none - private: - description: Whether or not this project can be seen by everyone. - Only present if owner is an organization. - type: boolean - required: - - id - - node_id - - number - - name - - body - - state - - url - - html_url - - owner_url - - creator - - columns_url - - created_at - - updated_at - 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: true - headers: - Link: *52 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create an organization 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: - - projects-classic - operationId: projects-classic/create-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#create-an-organization-project - parameters: - - *61 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the project. - body: - type: string - description: The description of the project. - required: - - name - examples: - default: - value: - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - responses: - '201': - description: Response - content: - application/json: - schema: *238 - 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' - '401': *23 - '403': *27 - '404': *6 - '410': &314 - description: Gone - content: - application/json: - schema: *3 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/orgs/{org}/projectsV2": get: summary: List projects for organization @@ -36296,7 +36516,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &733 + - &732 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -36683,7 +36903,7 @@ paths: - updated_at - project_url examples: - default: &672 + default: &671 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -36787,7 +37007,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *241 - - &673 + - &672 name: field_id description: The unique identifier of the field. in: path @@ -36802,7 +37022,7 @@ paths: application/json: schema: *242 examples: - default: &674 + default: &673 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -37685,7 +37905,7 @@ paths: description: Response content: application/json: - schema: &675 + schema: &674 title: Projects v2 Item description: An item belonging to a project type: object @@ -37699,7 +37919,7 @@ paths: content: oneOf: - *78 - - &442 + - &440 title: Pull Request Simple description: Pull Request Simple type: object @@ -37874,7 +38094,7 @@ paths: type: - array - 'null' - items: *169 + items: *170 head: type: object properties: @@ -37944,7 +38164,7 @@ paths: - review_comment - self author_association: *65 - auto_merge: &542 + auto_merge: &541 title: Auto merge description: The status of auto merging a pull request. type: @@ -38688,7 +38908,7 @@ paths: - *61 - *252 responses: - '204': *165 + '204': *166 '403': *27 '404': *6 x-github: @@ -39009,9 +39229,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: *228 + default: *229 headers: Link: *52 x-github: @@ -39214,7 +39434,7 @@ paths: description: Response content: application/json: - schema: &316 + schema: &314 title: Full Repository description: Full Repository type: object @@ -39679,7 +39899,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &447 + code_of_conduct: &445 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -39793,7 +40013,7 @@ paths: - network_count - subscribers_count examples: - default: &318 + default: &316 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -40314,7 +40534,7 @@ paths: - *61 - *17 - *19 - - &565 + - &564 name: targets description: | A comma-separated list of rule targets to filter by. @@ -40600,7 +40820,7 @@ paths: - object rules: type: array - items: &566 + items: &565 title: Repository Rule type: object description: A repository rule. @@ -40662,7 +40882,7 @@ paths: type: string enum: - required_linear_history - - &563 + - &562 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -41286,7 +41506,7 @@ paths: - tool required: - code_scanning_tools - - &564 + - &563 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -41512,7 +41732,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *61 - - &567 + - &566 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -41527,7 +41747,7 @@ paths: in: query schema: type: string - - &568 + - &567 name: time_period description: |- The time period to filter by. @@ -41543,14 +41763,14 @@ paths: - week - month default: day - - &569 + - &568 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &570 + - &569 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -41570,7 +41790,7 @@ paths: description: Response content: application/json: - schema: &571 + schema: &570 title: Rule Suites description: Response type: array @@ -41626,7 +41846,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &572 + default: &571 value: - id: 21 actor_id: 12 @@ -41670,7 +41890,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *61 - - &573 + - &572 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -41686,7 +41906,7 @@ paths: description: Response content: application/json: - schema: &574 + schema: &573 title: Rule Suite description: Response type: object @@ -41793,7 +42013,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &575 + default: &574 value: id: 21 actor_id: 12 @@ -42039,7 +42259,7 @@ paths: type: string format: date-time examples: - default: &577 + default: &576 value: - version_id: 3 actor: @@ -42092,7 +42312,7 @@ paths: description: Response content: application/json: - schema: &578 + schema: &577 allOf: - *283 - type: object @@ -42164,7 +42384,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *61 - - &579 + - &578 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -42175,7 +42395,7 @@ paths: enum: - open - resolved - - &580 + - &579 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -42185,7 +42405,7 @@ paths: required: false schema: type: string - - &581 + - &580 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -42194,7 +42414,7 @@ paths: required: false schema: type: string - - &582 + - &581 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -42209,7 +42429,7 @@ paths: - *46 - *19 - *17 - - &583 + - &582 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -42219,7 +42439,7 @@ paths: required: false schema: type: string - - &584 + - &583 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -42229,7 +42449,7 @@ paths: required: false schema: type: string - - &585 + - &584 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -42238,7 +42458,7 @@ paths: required: false schema: type: string - - &586 + - &585 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -42247,7 +42467,7 @@ paths: schema: type: boolean default: false - - &587 + - &586 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -42256,7 +42476,7 @@ paths: schema: type: boolean default: false - - &588 + - &587 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -42275,27 +42495,27 @@ paths: items: type: object properties: - number: *151 - created_at: *152 + number: *152 + created_at: *153 updated_at: anyOf: - type: 'null' - - *153 - url: *154 - html_url: *155 + - *154 + url: *155 + html_url: *156 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &589 + state: &588 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &590 + resolution: &589 type: - string - 'null' @@ -42402,14 +42622,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &591 + - &590 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &593 + - &592 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -42466,7 +42686,7 @@ paths: - blob_url - commit_sha - commit_url - - &594 + - &593 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -42527,7 +42747,7 @@ paths: - page_url - commit_sha - commit_url - - &595 + - &594 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -42542,7 +42762,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &596 + - &595 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -42557,7 +42777,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &597 + - &596 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -42572,7 +42792,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &598 + - &597 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -42587,7 +42807,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &599 + - &598 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -42602,7 +42822,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &600 + - &599 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -42617,7 +42837,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &601 + - &600 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -42632,7 +42852,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &602 + - &601 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -42647,7 +42867,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &603 + - &602 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -42662,7 +42882,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &604 + - &603 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -42677,7 +42897,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &605 + - &604 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -43177,7 +43397,7 @@ paths: application/json: schema: type: array - items: &609 + items: &608 description: A repository security advisory. type: object properties: @@ -43458,7 +43678,7 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *169 + items: *170 private_fork: readOnly: true description: A temporary private fork of the advisory's repository @@ -43496,7 +43716,7 @@ paths: - private_fork additionalProperties: false examples: - default: &610 + default: &609 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -43883,9 +44103,9 @@ paths: application/json: schema: type: array - items: *220 + items: *221 examples: - default: *221 + default: *222 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43970,7 +44190,7 @@ paths: description: Response content: application/json: - schema: &676 + schema: &675 type: object properties: total_minutes_used: @@ -44040,7 +44260,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &677 + default: &676 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -44076,7 +44296,7 @@ paths: description: Response content: application/json: - schema: &678 + schema: &677 type: object properties: total_gigabytes_bandwidth_used: @@ -44094,7 +44314,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &679 + default: &678 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -44126,7 +44346,7 @@ paths: description: Response content: application/json: - schema: &681 + schema: &680 type: object properties: days_left_in_billing_cycle: @@ -44144,7 +44364,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &682 + default: &681 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -44294,9 +44514,9 @@ paths: type: integer repositories: type: array - items: *135 + items: *136 examples: - default: *147 + default: *148 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44365,7 +44585,7 @@ paths: url: https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *61 - - *124 + - *125 responses: '204': description: Response @@ -44388,7 +44608,7 @@ paths: url: https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *61 - - *124 + - *125 responses: '204': description: Response @@ -44861,9 +45081,9 @@ paths: application/json: schema: type: array - items: *169 + items: *170 examples: - default: *221 + default: *222 headers: Link: *52 '403': *27 @@ -45031,7 +45251,7 @@ paths: parent: anyOf: - type: 'null' - - *220 + - *221 members_count: type: integer examples: @@ -45710,7 +45930,7 @@ paths: - updated_at - url examples: - default: &627 + default: &626 value: - author: login: octocat @@ -45958,7 +46178,7 @@ paths: application/json: schema: *295 examples: - default: &628 + default: &627 value: author: login: octocat @@ -46149,7 +46369,7 @@ paths: - updated_at - url examples: - default: &629 + default: &628 value: - author: login: octocat @@ -46375,7 +46595,7 @@ paths: application/json: schema: *298 examples: - default: &630 + default: &629 value: author: login: octocat @@ -46879,9 +47099,9 @@ paths: application/json: schema: type: array - items: *202 + items: *203 examples: - default: *203 + default: *204 headers: Link: *52 x-github: @@ -46993,7 +47213,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &631 + response-if-user-is-a-team-maintainer: &630 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -47058,7 +47278,7 @@ paths: application/json: schema: *305 examples: - response-if-users-membership-with-team-is-now-pending: &632 + response-if-users-membership-with-team-is-now-pending: &631 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -47200,7 +47420,7 @@ paths: - updated_at - permissions examples: - default: &633 + default: &632 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -47279,7 +47499,7 @@ paths: application/json: schema: *306 examples: - default: &634 + default: &633 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -47450,9 +47670,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: *228 + default: *229 headers: Link: *52 x-github: @@ -47490,7 +47710,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &635 + schema: &634 title: Team Repository description: A team's access to a repository. type: object @@ -48217,9 +48437,9 @@ paths: application/json: schema: type: array - items: *169 + items: *170 examples: - response-if-child-teams-exist: &636 + response-if-child-teams-exist: &635 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -48575,211 +48795,6 @@ paths: deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true - "/projects/{project_id}": - get: - summary: Get 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: - - projects-classic - operationId: projects-classic/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#get-a-project - parameters: - - *307 - responses: - '200': - description: Response - content: - application/json: - schema: *238 - examples: - default: &313 - value: - owner_url: https://api.github.com/repos/api-playground/projects-test - url: https://api.github.com/projects/1002604 - html_url: https://github.com/api-playground/projects-test/projects/1 - columns_url: https://api.github.com/projects/1002604/columns - id: 1002604 - node_id: MDc6UHJvamVjdDEwMDI2MDQ= - name: Projects Documentation - body: Developer documentation project for the developer site. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - '304': *35 - '403': *27 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update 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. - operationId: projects-classic/update - tags: - - projects-classic - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#update-a-project - parameters: - - *307 - requestBody: - required: false - content: - application/json: - schema: - properties: - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - state: - description: State of the project; either 'open' or 'closed' - type: string - examples: - - open - organization_permission: - description: The baseline permission that all organization members - have on this project - type: string - enum: - - read - - write - - admin - - none - private: - description: Whether or not this project can be seen by everyone. - type: boolean - type: object - examples: - default: - summary: Change the name, state, and permissions for a project - value: - name: Week One Sprint - state: open - organization_permission: write - responses: - '200': - description: Response - content: - application/json: - schema: *238 - examples: - default: *313 - '404': - description: Not Found if the authenticated user does not have access to - the project - '304': *35 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *23 - '410': *314 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete 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. - operationId: projects-classic/delete - tags: - - projects-classic - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#delete-a-project - parameters: - - *307 - responses: - '204': - description: Delete Success - '304': *35 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *23 - '410': *314 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/projects/{project_id}/collaborators": get: summary: List project collaborators @@ -49036,7 +49051,7 @@ paths: resources: type: object properties: - core: &315 + core: &313 title: Rate Limit type: object properties: @@ -49053,21 +49068,21 @@ paths: - remaining - reset - used - graphql: *315 - search: *315 - code_search: *315 - source_import: *315 - integration_manifest: *315 - code_scanning_upload: *315 - actions_runner_registration: *315 - scim: *315 - dependency_snapshots: *315 - dependency_sbom: *315 - code_scanning_autofix: *315 + graphql: *313 + search: *313 + code_search: *313 + source_import: *313 + integration_manifest: *313 + code_scanning_upload: *313 + actions_runner_registration: *313 + scim: *313 + dependency_snapshots: *313 + dependency_sbom: *313 + code_scanning_autofix: *313 required: - core - search - rate: *315 + rate: *313 required: - rate - resources @@ -49179,7 +49194,7 @@ paths: description: Response content: application/json: - schema: *316 + schema: *314 examples: default-response: summary: Default response @@ -49680,7 +49695,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *317 + '301': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49947,10 +49962,10 @@ paths: description: Response content: application/json: - schema: *316 + schema: *314 examples: - default: *318 - '307': &319 + default: *316 + '307': &317 description: Temporary Redirect content: application/json: @@ -50002,7 +50017,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *319 + '307': *317 '404': *6 '409': *45 x-github: @@ -50030,7 +50045,7 @@ paths: - *309 - *17 - *19 - - &350 + - &348 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -50053,7 +50068,7 @@ paths: type: integer artifacts: type: array - items: &320 + items: &318 title: Artifact description: An artifact type: object @@ -50148,7 +50163,7 @@ paths: - expires_at - updated_at examples: - default: &351 + default: &349 value: total_count: 2 artifacts: @@ -50211,7 +50226,7 @@ paths: parameters: - *308 - *309 - - &321 + - &319 name: artifact_id description: The unique identifier of the artifact. in: path @@ -50223,7 +50238,7 @@ paths: description: Response content: application/json: - schema: *320 + schema: *318 examples: default: value: @@ -50263,7 +50278,7 @@ paths: parameters: - *308 - *309 - - *321 + - *319 responses: '204': description: Response @@ -50289,7 +50304,7 @@ paths: parameters: - *308 - *309 - - *321 + - *319 - name: archive_format in: path required: true @@ -50303,7 +50318,11 @@ 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': *314 + '410': &499 + description: Gone + content: + application/json: + schema: *3 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50333,7 +50352,7 @@ paths: description: Response content: application/json: - schema: *322 + schema: *320 examples: default: value: @@ -50363,7 +50382,7 @@ paths: - *309 - *17 - *19 - - &323 + - &321 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 @@ -50397,7 +50416,7 @@ paths: description: Response content: application/json: - schema: &324 + schema: &322 title: Repository actions caches description: Repository actions caches type: object @@ -50447,7 +50466,7 @@ paths: - total_count - actions_caches examples: - default: &325 + default: &323 value: total_count: 1 actions_caches: @@ -50487,15 +50506,15 @@ paths: required: true schema: type: string - - *323 + - *321 responses: '200': description: Response content: application/json: - schema: *324 + schema: *322 examples: - default: *325 + default: *323 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50549,7 +50568,7 @@ paths: parameters: - *308 - *309 - - &326 + - &324 name: job_id description: The unique identifier of the job. in: path @@ -50561,7 +50580,7 @@ paths: description: Response content: application/json: - schema: &354 + schema: &352 title: Job description: Information of a job execution in a workflow run type: object @@ -50910,7 +50929,7 @@ paths: parameters: - *308 - *309 - - *326 + - *324 responses: '302': description: Response @@ -50940,7 +50959,7 @@ paths: parameters: - *308 - *309 - - *326 + - *324 requestBody: required: false content: @@ -50962,7 +50981,7 @@ paths: description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -51072,7 +51091,7 @@ paths: description: Empty response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -51120,7 +51139,7 @@ paths: type: integer secrets: type: array - items: &356 + items: &354 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -51141,7 +51160,7 @@ paths: - created_at - updated_at examples: - default: &357 + default: &355 value: total_count: 2 secrets: @@ -51176,7 +51195,7 @@ paths: parameters: - *308 - *309 - - *327 + - *325 - *19 responses: '200': @@ -51193,7 +51212,7 @@ paths: type: integer variables: type: array - items: &360 + items: &358 title: Actions Variable type: object properties: @@ -51227,7 +51246,7 @@ paths: - created_at - updated_at examples: - default: &361 + default: &359 value: total_count: 2 variables: @@ -51270,12 +51289,12 @@ paths: schema: type: object properties: - enabled: &329 + enabled: &327 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *120 - selected_actions_url: *328 - sha_pinning_required: *121 + allowed_actions: *121 + selected_actions_url: *326 + sha_pinning_required: *122 required: - enabled examples: @@ -51315,9 +51334,9 @@ paths: schema: type: object properties: - enabled: *329 - allowed_actions: *120 - sha_pinning_required: *121 + enabled: *327 + allowed_actions: *121 + sha_pinning_required: *122 required: - enabled examples: @@ -51354,7 +51373,7 @@ paths: description: Response content: application/json: - schema: &330 + schema: &328 type: object properties: access_level: @@ -51371,7 +51390,7 @@ paths: required: - access_level examples: - default: &331 + default: &329 value: access_level: organization x-github: @@ -51401,9 +51420,9 @@ paths: required: true content: application/json: - schema: *330 + schema: *328 examples: - default: *331 + default: *329 responses: '204': description: Response @@ -51434,7 +51453,7 @@ paths: description: Response content: application/json: - schema: *332 + schema: *330 examples: default: value: @@ -51469,7 +51488,7 @@ paths: required: true content: application/json: - schema: *333 + schema: *331 examples: default: summary: Set retention days @@ -51500,9 +51519,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *123 examples: - default: *334 + default: *332 '404': *6 x-github: enabledForGitHubApps: true @@ -51532,7 +51551,7 @@ paths: required: true content: application/json: - schema: *122 + schema: *123 examples: default: summary: Set approval policy to first time contributors @@ -51563,9 +51582,9 @@ paths: description: Response content: application/json: - schema: *335 + schema: *333 examples: - default: *123 + default: *124 '403': *27 '404': *6 x-github: @@ -51591,9 +51610,9 @@ paths: required: true content: application/json: - schema: *336 + schema: *334 examples: - default: *123 + default: *124 responses: '204': description: Empty response for successful settings update @@ -51624,9 +51643,9 @@ paths: description: Response content: application/json: - schema: *125 + schema: *126 examples: - default: *126 + default: *127 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -51654,9 +51673,9 @@ paths: required: false content: application/json: - schema: *125 + schema: *126 examples: - selected_actions: *126 + selected_actions: *127 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -51685,9 +51704,9 @@ paths: description: Response content: application/json: - schema: *337 + schema: *335 examples: - default: *130 + default: *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51720,9 +51739,9 @@ paths: required: true content: application/json: - schema: *338 + schema: *336 examples: - default: *130 + default: *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51768,9 +51787,9 @@ paths: type: integer runners: type: array - items: *137 + items: *138 examples: - default: *138 + default: *139 headers: Link: *52 x-github: @@ -51803,9 +51822,9 @@ paths: application/json: schema: type: array - items: *339 + items: *337 examples: - default: *340 + default: *338 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51871,7 +51890,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *341 + '201': *339 '404': *6 '422': *7 '409': *45 @@ -51909,9 +51928,9 @@ paths: description: Response content: application/json: - schema: *139 + schema: *140 examples: - default: *342 + default: *340 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51946,9 +51965,9 @@ paths: description: Response content: application/json: - schema: *139 + schema: *140 examples: - default: *343 + default: *341 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51972,15 +51991,15 @@ paths: parameters: - *308 - *309 - - *136 + - *137 responses: '200': description: Response content: application/json: - schema: *137 + schema: *138 examples: - default: *344 + default: *342 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52003,7 +52022,7 @@ paths: parameters: - *308 - *309 - - *136 + - *137 responses: '204': description: Response @@ -52031,9 +52050,9 @@ paths: parameters: - *308 - *309 - - *136 + - *137 responses: - '200': *141 + '200': *142 '404': *6 x-github: githubCloudOnly: false @@ -52057,7 +52076,7 @@ paths: parameters: - *308 - *309 - - *136 + - *137 requestBody: required: true content: @@ -52081,7 +52100,7 @@ paths: - gpu - accelerated responses: - '200': *141 + '200': *142 '404': *6 '422': *7 x-github: @@ -52107,7 +52126,7 @@ paths: parameters: - *308 - *309 - - *136 + - *137 requestBody: required: true content: @@ -52132,7 +52151,7 @@ paths: - gpu - accelerated responses: - '200': *141 + '200': *142 '404': *6 '422': *7 x-github: @@ -52158,9 +52177,9 @@ paths: parameters: - *308 - *309 - - *136 + - *137 responses: - '200': *345 + '200': *343 '404': *6 x-github: githubCloudOnly: false @@ -52189,10 +52208,10 @@ paths: parameters: - *308 - *309 - - *136 - - *346 + - *137 + - *344 responses: - '200': *141 + '200': *142 '404': *6 '422': *7 x-github: @@ -52220,7 +52239,7 @@ paths: parameters: - *308 - *309 - - &364 + - &362 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. @@ -52228,7 +52247,7 @@ paths: required: false schema: type: string - - &365 + - &363 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -52236,7 +52255,7 @@ paths: required: false schema: type: string - - &366 + - &364 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -52245,7 +52264,7 @@ paths: required: false schema: type: string - - &367 + - &365 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 @@ -52272,7 +52291,7 @@ paths: - pending - *17 - *19 - - &368 + - &366 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)." @@ -52281,7 +52300,7 @@ paths: schema: type: string format: date-time - - &347 + - &345 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -52290,13 +52309,13 @@ paths: schema: type: boolean default: false - - &369 + - &367 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &370 + - &368 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -52319,7 +52338,7 @@ paths: type: integer workflow_runs: type: array - items: &348 + items: &346 title: Workflow Run description: An invocation of a workflow type: object @@ -52436,7 +52455,7 @@ paths: type: - array - 'null' - items: &389 + items: &387 title: Pull Request Minimal type: object properties: @@ -52563,7 +52582,7 @@ paths: head_commit: anyOf: - type: 'null' - - &393 + - &391 title: Simple Commit description: A commit. type: object @@ -52637,8 +52656,8 @@ paths: - timestamp - author - committer - repository: *135 - head_repository: *135 + repository: *136 + head_repository: *136 head_repository_id: type: integer examples: @@ -52678,7 +52697,7 @@ paths: - workflow_url - pull_requests examples: - default: &371 + default: &369 value: total_count: 1 workflow_runs: @@ -52916,22 +52935,22 @@ paths: parameters: - *308 - *309 - - &349 + - &347 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *347 + - *345 responses: '200': description: Response content: application/json: - schema: *348 + schema: *346 examples: - default: &352 + default: &350 value: id: 30433642 name: Build @@ -53174,7 +53193,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 responses: '204': description: Response @@ -53199,7 +53218,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 responses: '200': description: Response @@ -53329,13 +53348,13 @@ paths: parameters: - *308 - *309 - - *349 + - *347 responses: '201': description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -53364,10 +53383,10 @@ paths: parameters: - *308 - *309 - - *349 + - *347 - *17 - *19 - - *350 + - *348 responses: '200': description: Response @@ -53383,9 +53402,9 @@ paths: type: integer artifacts: type: array - items: *320 + items: *318 examples: - default: *351 + default: *349 headers: Link: *52 x-github: @@ -53411,23 +53430,23 @@ paths: parameters: - *308 - *309 - - *349 - - &353 + - *347 + - &351 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *347 + - *345 responses: '200': description: Response content: application/json: - schema: *348 + schema: *346 examples: - default: *352 + default: *350 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53452,8 +53471,8 @@ paths: parameters: - *308 - *309 - - *349 - - *353 + - *347 + - *351 - *17 - *19 responses: @@ -53471,9 +53490,9 @@ paths: type: integer jobs: type: array - items: *354 + items: *352 examples: - default: &355 + default: &353 value: total_count: 1 jobs: @@ -53588,8 +53607,8 @@ paths: parameters: - *308 - *309 - - *349 - - *353 + - *347 + - *351 responses: '302': description: Response @@ -53619,13 +53638,13 @@ paths: parameters: - *308 - *309 - - *349 + - *347 responses: '202': description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -53654,7 +53673,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 requestBody: required: true content: @@ -53723,13 +53742,13 @@ paths: parameters: - *308 - *309 - - *349 + - *347 responses: '202': description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -53758,7 +53777,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 - 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 @@ -53788,9 +53807,9 @@ paths: type: integer jobs: type: array - items: *354 + items: *352 examples: - default: *355 + default: *353 headers: Link: *52 x-github: @@ -53817,7 +53836,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 responses: '302': description: Response @@ -53846,7 +53865,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 responses: '204': description: Response @@ -53875,7 +53894,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 responses: '200': description: Response @@ -53944,7 +53963,7 @@ paths: items: type: object properties: - type: &467 + type: &465 type: string description: The type of reviewer. enum: @@ -53955,7 +53974,7 @@ paths: reviewer: anyOf: - *4 - - *169 + - *170 required: - environment - wait_timer @@ -54032,7 +54051,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 requestBody: required: true content: @@ -54082,7 +54101,7 @@ paths: application/json: schema: type: array - items: &462 + items: &460 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -54194,7 +54213,7 @@ paths: - created_at - updated_at examples: - default: &463 + default: &461 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -54252,7 +54271,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 requestBody: required: false content: @@ -54274,7 +54293,7 @@ paths: description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -54299,7 +54318,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 requestBody: required: false content: @@ -54321,7 +54340,7 @@ paths: description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -54355,7 +54374,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 responses: '200': description: Response @@ -54511,9 +54530,9 @@ paths: type: integer secrets: type: array - items: *356 + items: *354 examples: - default: *357 + default: *355 headers: Link: *52 x-github: @@ -54545,9 +54564,9 @@ paths: description: Response content: application/json: - schema: *358 + schema: *356 examples: - default: *359 + default: *357 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54571,15 +54590,15 @@ paths: parameters: - *308 - *309 - - *143 + - *144 responses: '200': description: Response content: application/json: - schema: *356 + schema: *354 examples: - default: &480 + default: &478 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -54607,7 +54626,7 @@ paths: parameters: - *308 - *309 - - *143 + - *144 requestBody: required: true content: @@ -54638,7 +54657,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -54666,7 +54685,7 @@ paths: parameters: - *308 - *309 - - *143 + - *144 responses: '204': description: Response @@ -54693,7 +54712,7 @@ paths: parameters: - *308 - *309 - - *327 + - *325 - *19 responses: '200': @@ -54710,9 +54729,9 @@ paths: type: integer variables: type: array - items: *360 + items: *358 examples: - default: *361 + default: *359 headers: Link: *52 x-github: @@ -54763,7 +54782,7 @@ paths: description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -54790,15 +54809,15 @@ paths: parameters: - *308 - *309 - - *146 + - *147 responses: '200': description: Response content: application/json: - schema: *360 + schema: *358 examples: - default: &481 + default: &479 value: name: USERNAME value: octocat @@ -54826,7 +54845,7 @@ paths: parameters: - *308 - *309 - - *146 + - *147 requestBody: required: true content: @@ -54870,7 +54889,7 @@ paths: parameters: - *308 - *309 - - *146 + - *147 responses: '204': description: Response @@ -54914,7 +54933,7 @@ paths: type: integer workflows: type: array - items: &362 + items: &360 title: Workflow description: A GitHub Actions workflow type: object @@ -55034,7 +55053,7 @@ paths: parameters: - *308 - *309 - - &363 + - &361 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -55049,7 +55068,7 @@ paths: description: Response content: application/json: - schema: *362 + schema: *360 examples: default: value: @@ -55084,7 +55103,7 @@ paths: parameters: - *308 - *309 - - *363 + - *361 responses: '204': description: Response @@ -55111,7 +55130,7 @@ paths: parameters: - *308 - *309 - - *363 + - *361 responses: '204': description: Response @@ -55164,7 +55183,7 @@ paths: parameters: - *308 - *309 - - *363 + - *361 responses: '204': description: Response @@ -55193,17 +55212,17 @@ paths: parameters: - *308 - *309 + - *361 + - *362 - *363 - *364 - *365 - - *366 - - *367 - *17 - *19 + - *366 + - *345 + - *367 - *368 - - *347 - - *369 - - *370 responses: '200': description: Response @@ -55219,9 +55238,9 @@ paths: type: integer workflow_runs: type: array - items: *348 + items: *346 examples: - default: *371 + default: *369 headers: Link: *52 x-github: @@ -55255,7 +55274,7 @@ paths: parameters: - *308 - *309 - - *363 + - *361 responses: '200': description: Response @@ -55731,7 +55750,7 @@ paths: initiator: type: string examples: - default: *372 + default: *370 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55760,7 +55779,7 @@ paths: application/json: schema: type: array - items: &373 + items: &371 title: Autolink reference description: An autolink reference. type: object @@ -55859,9 +55878,9 @@ paths: description: response content: application/json: - schema: *373 + schema: *371 examples: - default: &374 + default: &372 value: id: 1 key_prefix: TICKET- @@ -55894,7 +55913,7 @@ paths: parameters: - *308 - *309 - - &375 + - &373 name: autolink_id description: The unique identifier of the autolink. in: path @@ -55906,9 +55925,9 @@ paths: description: Response content: application/json: - schema: *373 + schema: *371 examples: - default: *374 + default: *372 '404': *6 x-github: githubCloudOnly: false @@ -55930,7 +55949,7 @@ paths: parameters: - *308 - *309 - - *375 + - *373 responses: '204': description: Response @@ -56087,7 +56106,7 @@ paths: - url protected: type: boolean - protection: &377 + protection: &375 title: Branch Protection description: Branch Protection type: object @@ -56130,7 +56149,7 @@ paths: required: - contexts - checks - enforce_admins: &380 + enforce_admins: &378 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -56147,7 +56166,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &382 + required_pull_request_reviews: &380 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -56169,7 +56188,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *169 + items: *170 apps: description: The list of apps with review dismissal access. @@ -56201,7 +56220,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *169 + items: *170 apps: description: The list of apps allowed to bypass pull request requirements. @@ -56231,7 +56250,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &379 + restrictions: &377 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -56294,7 +56313,7 @@ paths: type: string teams: type: array - items: *169 + items: *170 apps: type: array items: @@ -56526,7 +56545,7 @@ paths: parameters: - *308 - *309 - - &378 + - &376 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). @@ -56540,14 +56559,14 @@ paths: description: Response content: application/json: - schema: &388 + schema: &386 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &438 + commit: &436 title: Commit description: Commit type: object @@ -56586,7 +56605,7 @@ paths: author: anyOf: - type: 'null' - - &376 + - &374 title: Git User description: Metaproperties for Git author/committer information. @@ -56607,7 +56626,7 @@ paths: committer: anyOf: - type: 'null' - - *376 + - *374 message: type: string examples: @@ -56631,7 +56650,7 @@ paths: required: - sha - url - verification: &487 + verification: &485 title: Verification type: object properties: @@ -56667,14 +56686,14 @@ paths: author: oneOf: - *4 - - *144 + - *145 type: - 'null' - object committer: oneOf: - *4 - - *144 + - *145 type: - 'null' - object @@ -56711,7 +56730,7 @@ paths: type: integer files: type: array - items: &449 + items: &447 title: Diff Entry description: Diff Entry type: object @@ -56807,7 +56826,7 @@ paths: - self protected: type: boolean - protection: *377 + protection: *375 protection_url: type: string format: uri @@ -56916,7 +56935,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *317 + '301': *315 '404': *6 x-github: githubCloudOnly: false @@ -56940,13 +56959,13 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response content: application/json: - schema: *377 + schema: *375 examples: default: value: @@ -57142,7 +57161,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: true content: @@ -57402,7 +57421,7 @@ paths: url: type: string format: uri - required_status_checks: &385 + required_status_checks: &383 title: Status Check Policy description: Status Check Policy type: object @@ -57483,7 +57502,7 @@ paths: items: *4 teams: type: array - items: *169 + items: *170 apps: type: array items: *5 @@ -57501,7 +57520,7 @@ paths: items: *4 teams: type: array - items: *169 + items: *170 apps: type: array items: *5 @@ -57561,7 +57580,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *379 + restrictions: *377 required_conversation_resolution: type: object properties: @@ -57675,7 +57694,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '204': description: Response @@ -57702,15 +57721,15 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response content: application/json: - schema: *380 + schema: *378 examples: - default: &381 + default: &379 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -57734,15 +57753,15 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response content: application/json: - schema: *380 + schema: *378 examples: - default: *381 + default: *379 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57763,7 +57782,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '204': description: Response @@ -57790,15 +57809,15 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response content: application/json: - schema: *382 + schema: *380 examples: - default: &383 + default: &381 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -57896,7 +57915,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: false content: @@ -57994,9 +58013,9 @@ paths: description: Response content: application/json: - schema: *382 + schema: *380 examples: - default: *383 + default: *381 '422': *15 x-github: githubCloudOnly: false @@ -58019,7 +58038,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '204': description: Response @@ -58048,15 +58067,15 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response content: application/json: - schema: *380 + schema: *378 examples: - default: &384 + default: &382 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -58081,15 +58100,15 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response content: application/json: - schema: *380 + schema: *378 examples: - default: *384 + default: *382 '404': *6 x-github: githubCloudOnly: false @@ -58111,7 +58130,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '204': description: Response @@ -58138,15 +58157,15 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response content: application/json: - schema: *385 + schema: *383 examples: - default: &386 + default: &384 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -58174,7 +58193,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: false content: @@ -58226,9 +58245,9 @@ paths: description: Response content: application/json: - schema: *385 + schema: *383 examples: - default: *386 + default: *384 '404': *6 '422': *15 x-github: @@ -58252,7 +58271,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '204': description: Response @@ -58278,7 +58297,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response @@ -58314,7 +58333,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: false content: @@ -58383,7 +58402,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: false content: @@ -58449,7 +58468,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: content: application/json: @@ -58517,13 +58536,13 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response content: application/json: - schema: *379 + schema: *377 examples: default: value: @@ -58616,7 +58635,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '204': description: Response @@ -58641,7 +58660,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response @@ -58651,7 +58670,7 @@ paths: type: array items: *5 examples: - default: &387 + default: &385 value: - id: 1 slug: octoapp @@ -58710,7 +58729,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: true content: @@ -58744,7 +58763,7 @@ paths: type: array items: *5 examples: - default: *387 + default: *385 '422': *15 x-github: githubCloudOnly: false @@ -58767,7 +58786,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: true content: @@ -58801,7 +58820,7 @@ paths: type: array items: *5 examples: - default: *387 + default: *385 '422': *15 x-github: githubCloudOnly: false @@ -58824,7 +58843,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: true content: @@ -58858,7 +58877,7 @@ paths: type: array items: *5 examples: - default: *387 + default: *385 '422': *15 x-github: githubCloudOnly: false @@ -58882,7 +58901,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response @@ -58890,9 +58909,9 @@ paths: application/json: schema: type: array - items: *169 + items: *170 examples: - default: *221 + default: *222 '404': *6 x-github: githubCloudOnly: false @@ -58914,7 +58933,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: false content: @@ -58950,9 +58969,9 @@ paths: application/json: schema: type: array - items: *169 + items: *170 examples: - default: *221 + default: *222 '422': *15 x-github: githubCloudOnly: false @@ -58975,7 +58994,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: false content: @@ -59011,9 +59030,9 @@ paths: application/json: schema: type: array - items: *169 + items: *170 examples: - default: *221 + default: *222 '422': *15 x-github: githubCloudOnly: false @@ -59036,7 +59055,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: content: application/json: @@ -59071,9 +59090,9 @@ paths: application/json: schema: type: array - items: *169 + items: *170 examples: - default: *221 + default: *222 '422': *15 x-github: githubCloudOnly: false @@ -59097,7 +59116,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response @@ -59133,7 +59152,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: true content: @@ -59193,7 +59212,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: true content: @@ -59253,7 +59272,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: true content: @@ -59315,7 +59334,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: true content: @@ -59337,7 +59356,7 @@ paths: description: Response content: application/json: - schema: *388 + schema: *386 examples: default: value: @@ -59733,7 +59752,7 @@ paths: description: Response content: application/json: - schema: &390 + schema: &388 title: CheckRun description: A check performed on the code of a given code change type: object @@ -59868,8 +59887,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *389 - deployment: &694 + items: *387 + deployment: &693 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -60158,7 +60177,7 @@ paths: parameters: - *308 - *309 - - &391 + - &389 name: check_run_id description: The unique identifier of the check run. in: path @@ -60170,9 +60189,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *388 examples: - default: &392 + default: &390 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -60274,7 +60293,7 @@ paths: parameters: - *308 - *309 - - *391 + - *389 requestBody: required: true content: @@ -60514,9 +60533,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *388 examples: - default: *392 + default: *390 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60538,7 +60557,7 @@ paths: parameters: - *308 - *309 - - *391 + - *389 - *17 - *19 responses: @@ -60650,13 +60669,13 @@ paths: parameters: - *308 - *309 - - *391 + - *389 responses: '201': description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -60717,7 +60736,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &394 + schema: &392 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -60799,12 +60818,12 @@ paths: type: - array - 'null' - items: *389 + items: *387 app: anyOf: - type: 'null' - *5 - repository: *135 + repository: *136 created_at: type: - string @@ -60815,7 +60834,7 @@ paths: - string - 'null' format: date-time - head_commit: *393 + head_commit: *391 latest_check_runs_count: type: integer check_runs_url: @@ -60843,7 +60862,7 @@ paths: - check_runs_url - pull_requests examples: - default: &395 + default: &393 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -61134,9 +61153,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *394 + schema: *392 examples: - default: *395 + default: *393 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61217,7 +61236,7 @@ paths: required: - app_id - setting - repository: *135 + repository: *136 examples: default: value: @@ -61467,7 +61486,7 @@ paths: parameters: - *308 - *309 - - &396 + - &394 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -61479,9 +61498,9 @@ paths: description: Response content: application/json: - schema: *394 + schema: *392 examples: - default: *395 + default: *393 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61506,15 +61525,15 @@ paths: parameters: - *308 - *309 - - *396 - - &444 + - *394 + - &442 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &445 + - &443 name: status description: Returns check runs with the specified `status`. in: query @@ -61553,9 +61572,9 @@ paths: type: integer check_runs: type: array - items: *390 + items: *388 examples: - default: &446 + default: &444 value: total_count: 1 check_runs: @@ -61659,13 +61678,13 @@ paths: parameters: - *308 - *309 - - *396 + - *394 responses: '201': description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -61694,19 +61713,19 @@ paths: parameters: - *308 - *309 - - *397 - - *398 + - *395 + - *396 - *19 - *17 - - &415 + - &413 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: *399 - - &416 + schema: *397 + - &414 name: pr description: The number of the pull request for the results you want to list. in: query @@ -61731,13 +61750,13 @@ paths: be returned. in: query required: false - schema: *400 + schema: *398 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *401 + schema: *399 responses: '200': description: Response @@ -61748,24 +61767,24 @@ paths: items: type: object properties: - number: *151 - created_at: *152 - updated_at: *153 - url: *154 - html_url: *155 - instances_url: *402 - state: *160 - fixed_at: *156 + number: *152 + created_at: *153 + updated_at: *154 + url: *155 + html_url: *156 + instances_url: *400 + state: *161 + fixed_at: *157 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *157 - dismissed_reason: *403 - dismissed_comment: *404 - rule: *405 - tool: *406 - most_recent_instance: *407 + dismissed_at: *158 + dismissed_reason: *401 + dismissed_comment: *402 + rule: *403 + tool: *404 + most_recent_instance: *405 dismissal_approved_by: anyOf: - type: 'null' @@ -61888,7 +61907,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &408 + '403': &406 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -61917,7 +61936,7 @@ paths: parameters: - *308 - *309 - - &409 + - &407 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -61925,30 +61944,30 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *151 + schema: *152 responses: '200': description: Response content: application/json: - schema: &410 + schema: &408 type: object properties: - number: *151 - created_at: *152 - updated_at: *153 - url: *154 - html_url: *155 - instances_url: *402 - state: *160 - fixed_at: *156 + number: *152 + created_at: *153 + updated_at: *154 + url: *155 + html_url: *156 + instances_url: *400 + state: *161 + fixed_at: *157 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *157 - dismissed_reason: *403 - dismissed_comment: *404 + dismissed_at: *158 + dismissed_reason: *401 + dismissed_comment: *402 rule: type: object properties: @@ -62010,8 +62029,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *406 - most_recent_instance: *407 + tool: *404 + most_recent_instance: *405 dismissal_approved_by: anyOf: - type: 'null' @@ -62107,7 +62126,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *408 + '403': *406 '404': *6 '503': *97 x-github: @@ -62129,7 +62148,7 @@ paths: parameters: - *308 - *309 - - *409 + - *407 requestBody: required: true content: @@ -62144,8 +62163,8 @@ paths: enum: - open - dismissed - dismissed_reason: *403 - dismissed_comment: *404 + dismissed_reason: *401 + dismissed_comment: *402 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -62164,7 +62183,7 @@ paths: description: Response content: application/json: - schema: *410 + schema: *408 examples: default: value: @@ -62240,7 +62259,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &414 + '403': &412 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -62269,13 +62288,13 @@ paths: parameters: - *308 - *309 - - *409 + - *407 responses: '200': description: Response content: application/json: - schema: &411 + schema: &409 type: object properties: status: @@ -62302,13 +62321,13 @@ paths: - description - started_at examples: - default: &412 + default: &410 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &413 + '400': &411 description: Bad Request content: application/json: @@ -62319,7 +62338,7 @@ 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': *408 + '403': *406 '404': *6 '503': *97 x-github: @@ -62346,27 +62365,27 @@ paths: parameters: - *308 - *309 - - *409 + - *407 responses: '200': description: OK content: application/json: - schema: *411 + schema: *409 examples: - default: *412 + default: *410 '202': description: Accepted content: application/json: - schema: *411 + schema: *409 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *413 + '400': *411 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -62400,7 +62419,7 @@ paths: parameters: - *308 - *309 - - *409 + - *407 requestBody: required: false content: @@ -62446,8 +62465,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *413 - '403': *414 + '400': *411 + '403': *412 '404': *6 '422': description: Unprocessable Entity @@ -62473,11 +62492,11 @@ paths: parameters: - *308 - *309 - - *409 + - *407 - *19 - *17 - - *415 - - *416 + - *413 + - *414 responses: '200': description: Response @@ -62485,7 +62504,7 @@ paths: application/json: schema: type: array - items: *407 + items: *405 examples: default: value: @@ -62524,7 +62543,7 @@ paths: end_column: 50 classifications: - source - '403': *408 + '403': *406 '404': *6 '503': *97 x-github: @@ -62560,23 +62579,23 @@ paths: parameters: - *308 - *309 - - *397 - - *398 + - *395 + - *396 - *19 - *17 - - *416 + - *414 - 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: *399 + schema: *397 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &419 + schema: &417 type: string description: An identifier for the upload. examples: @@ -62598,23 +62617,23 @@ paths: application/json: schema: type: array - items: &420 + items: &418 type: object properties: - ref: *399 - commit_sha: &428 + ref: *397 + commit_sha: &426 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: *417 + analysis_key: *415 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *418 + category: *416 error: type: string examples: @@ -62639,8 +62658,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *419 - tool: *406 + sarif_id: *417 + tool: *404 deletable: type: boolean warning: @@ -62702,7 +62721,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *408 + '403': *406 '404': *6 '503': *97 x-github: @@ -62752,7 +62771,7 @@ paths: description: Response content: application/json: - schema: *420 + schema: *418 examples: response: summary: application/json response @@ -62806,7 +62825,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *408 + '403': *406 '404': *6 '422': description: Response if analysis could not be processed @@ -62950,7 +62969,7 @@ 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': *414 + '403': *412 '404': *6 '503': *97 x-github: @@ -62981,7 +63000,7 @@ paths: application/json: schema: type: array - items: &421 + items: &419 title: CodeQL Database description: A CodeQL database. type: object @@ -63093,7 +63112,7 @@ 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': *408 + '403': *406 '404': *6 '503': *97 x-github: @@ -63135,7 +63154,7 @@ paths: description: Response content: application/json: - schema: *421 + schema: *419 examples: default: value: @@ -63167,9 +63186,9 @@ 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': &451 + '302': &449 description: Found - '403': *408 + '403': *406 '404': *6 '503': *97 x-github: @@ -63202,7 +63221,7 @@ paths: responses: '204': description: Response - '403': *414 + '403': *412 '404': *6 '503': *97 x-github: @@ -63240,7 +63259,7 @@ paths: type: object additionalProperties: false properties: - language: &422 + language: &420 type: string description: The language targeted by the CodeQL query enum: @@ -63319,7 +63338,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &426 + schema: &424 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -63329,7 +63348,7 @@ paths: description: The ID of the variant analysis. controller_repo: *51 actor: *4 - query_language: *422 + query_language: *420 query_pack_url: type: string description: The download url for the query pack. @@ -63377,7 +63396,7 @@ paths: items: type: object properties: - repository: &423 + repository: &421 title: Repository Identifier description: Repository Identifier type: object @@ -63419,7 +63438,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &427 + analysis_status: &425 type: string description: The new status of the CodeQL variant analysis repository task. @@ -63451,7 +63470,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &424 + access_mismatch_repos: &422 type: object properties: repository_count: @@ -63466,7 +63485,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: *423 + items: *421 required: - repository_count - repositories @@ -63489,8 +63508,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *424 - over_limit_repos: *424 + no_codeql_db_repos: *422 + over_limit_repos: *422 required: - access_mismatch_repos - not_found_repos @@ -63506,7 +63525,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &425 + value: &423 summary: Default response value: id: 1 @@ -63658,10 +63677,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *425 + value: *423 repository_lists: summary: Response for a successful variant analysis submission - value: *425 + value: *423 '404': *6 '422': description: Unable to process variant analysis submission @@ -63702,9 +63721,9 @@ paths: description: Response content: application/json: - schema: *426 + schema: *424 examples: - default: *425 + default: *423 '404': *6 '503': *97 x-github: @@ -63762,7 +63781,7 @@ paths: type: object properties: repository: *51 - analysis_status: *427 + analysis_status: *425 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -63981,7 +64000,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *408 + '403': *406 '404': *6 '503': *97 x-github: @@ -64072,7 +64091,7 @@ paths: description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -64097,7 +64116,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *414 + '403': *412 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -64177,7 +64196,7 @@ paths: schema: type: object properties: - commit_sha: *428 + commit_sha: *426 ref: type: string description: |- @@ -64237,7 +64256,7 @@ paths: schema: type: object properties: - id: *419 + id: *417 url: type: string description: The REST API URL for checking the status of the upload. @@ -64251,7 +64270,7 @@ 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': *414 + '403': *412 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -64323,7 +64342,7 @@ 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': *408 + '403': *406 '404': description: Not Found if the sarif id does not match any upload '503': *97 @@ -64405,7 +64424,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': *165 + '204': *166 '304': *35 '403': *27 '404': *6 @@ -64576,7 +64595,7 @@ paths: type: integer codespaces: type: array - items: *210 + items: *211 examples: default: value: @@ -64939,17 +64958,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '400': *14 '401': *23 '403': *27 @@ -65081,9 +65100,9 @@ paths: type: integer machines: type: array - items: *430 + items: *428 examples: - default: &643 + default: &642 value: total_count: 2 machines: @@ -65300,7 +65319,7 @@ paths: type: integer secrets: type: array - items: &434 + items: &432 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -65321,7 +65340,7 @@ paths: - created_at - updated_at examples: - default: *431 + default: *429 headers: Link: *52 x-github: @@ -65351,9 +65370,9 @@ paths: description: Response content: application/json: - schema: *432 + schema: *430 examples: - default: *433 + default: *431 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65375,15 +65394,15 @@ paths: parameters: - *308 - *309 - - *143 + - *144 responses: '200': description: Response content: application/json: - schema: *434 + schema: *432 examples: - default: *435 + default: *433 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65405,7 +65424,7 @@ paths: parameters: - *308 - *309 - - *143 + - *144 requestBody: required: true content: @@ -65433,7 +65452,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -65459,7 +65478,7 @@ paths: parameters: - *308 - *309 - - *143 + - *144 responses: '204': description: Response @@ -65526,7 +65545,7 @@ paths: application/json: schema: type: array - items: &436 + items: &434 title: Collaborator description: Collaborator type: object @@ -65795,7 +65814,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &500 + schema: &498 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -65807,7 +65826,7 @@ paths: format: int64 examples: - 42 - repository: *135 + repository: *136 invitee: anyOf: - type: 'null' @@ -65983,7 +66002,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *104 + schema: *105 '403': *27 x-github: triggersNotification: true @@ -66078,7 +66097,7 @@ paths: user: anyOf: - type: 'null' - - *436 + - *434 required: - permission - role_name @@ -66143,7 +66162,7 @@ paths: application/json: schema: type: array - items: &437 + items: &435 title: Commit Comment description: Commit Comment type: object @@ -66201,7 +66220,7 @@ paths: - created_at - updated_at examples: - default: &440 + default: &438 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66268,9 +66287,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *435 examples: - default: &441 + default: &439 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66351,7 +66370,7 @@ paths: description: Response content: application/json: - schema: *437 + schema: *435 examples: default: value: @@ -66650,9 +66669,9 @@ paths: application/json: schema: type: array - items: *438 + items: *436 examples: - default: &549 + default: &548 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -66748,7 +66767,7 @@ paths: parameters: - *308 - *309 - - &439 + - &437 name: commit_sha description: The SHA of the commit. in: path @@ -66822,7 +66841,7 @@ paths: parameters: - *308 - *309 - - *439 + - *437 - *17 - *19 responses: @@ -66832,9 +66851,9 @@ paths: application/json: schema: type: array - items: *437 + items: *435 examples: - default: *440 + default: *438 headers: Link: *52 x-github: @@ -66864,7 +66883,7 @@ paths: parameters: - *308 - *309 - - *439 + - *437 requestBody: required: true content: @@ -66899,9 +66918,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *435 examples: - default: *441 + default: *439 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66931,7 +66950,7 @@ paths: parameters: - *308 - *309 - - *439 + - *437 - *17 - *19 responses: @@ -66941,9 +66960,9 @@ paths: application/json: schema: type: array - items: *442 + items: *440 examples: - default: &541 + default: &540 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -67484,7 +67503,7 @@ paths: - *309 - *19 - *17 - - &443 + - &441 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)" @@ -67499,9 +67518,9 @@ paths: description: Response content: application/json: - schema: *438 + schema: *436 examples: - default: &527 + default: &526 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -67616,9 +67635,9 @@ paths: parameters: - *308 - *309 + - *441 + - *442 - *443 - - *444 - - *445 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -67652,9 +67671,9 @@ paths: type: integer check_runs: type: array - items: *390 + items: *388 examples: - default: *446 + default: *444 headers: Link: *52 x-github: @@ -67681,7 +67700,7 @@ paths: parameters: - *308 - *309 - - *443 + - *441 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -67689,7 +67708,7 @@ paths: schema: type: integer example: 1 - - *444 + - *442 - *17 - *19 responses: @@ -67707,7 +67726,7 @@ paths: type: integer check_suites: type: array - items: *394 + items: *392 examples: default: value: @@ -67909,7 +67928,7 @@ paths: parameters: - *308 - *309 - - *443 + - *441 - *17 - *19 responses: @@ -67980,7 +67999,7 @@ paths: type: string total_count: type: integer - repository: *135 + repository: *136 commit_url: type: string format: uri @@ -68113,7 +68132,7 @@ paths: parameters: - *308 - *309 - - *443 + - *441 - *17 - *19 responses: @@ -68123,7 +68142,7 @@ paths: application/json: schema: type: array - items: &614 + items: &613 title: Status description: The status of a commit. type: object @@ -68204,7 +68223,7 @@ paths: site_admin: false headers: Link: *52 - '301': *317 + '301': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68266,11 +68285,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *447 + - *445 code_of_conduct_file: anyOf: - type: 'null' - - &448 + - &446 title: Community Health File type: object properties: @@ -68290,19 +68309,19 @@ paths: contributing: anyOf: - type: 'null' - - *448 + - *446 readme: anyOf: - type: 'null' - - *448 + - *446 issue_template: anyOf: - type: 'null' - - *448 + - *446 pull_request_template: anyOf: - type: 'null' - - *448 + - *446 required: - code_of_conduct - code_of_conduct_file @@ -68480,8 +68499,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *438 - merge_base_commit: *438 + base_commit: *436 + merge_base_commit: *436 status: type: string enum: @@ -68505,10 +68524,10 @@ paths: - 6 commits: type: array - items: *438 + items: *436 files: type: array - items: *449 + items: *447 required: - url - html_url @@ -68948,7 +68967,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &450 + response-if-content-is-a-file: &448 summary: Response if content is a file value: type: file @@ -69085,7 +69104,7 @@ paths: - size - type - url - - &554 + - &553 title: Content File description: Content File type: object @@ -69303,7 +69322,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *450 + response-if-content-is-a-file: *448 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -69372,7 +69391,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *451 + '302': *449 '304': *35 x-github: githubCloudOnly: false @@ -69491,7 +69510,7 @@ paths: description: Response content: application/json: - schema: &452 + schema: &450 title: File Commit description: File Commit type: object @@ -69647,7 +69666,7 @@ paths: description: Response content: application/json: - schema: *452 + schema: *450 examples: example-for-creating-a-file: value: @@ -69701,7 +69720,7 @@ paths: schema: oneOf: - *3 - - &482 + - &480 description: Repository rule violation was detected type: object properties: @@ -69722,7 +69741,7 @@ paths: items: type: object properties: - placeholder_id: &606 + placeholder_id: &605 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -69816,7 +69835,7 @@ paths: description: Response content: application/json: - schema: *452 + schema: *450 examples: default: value: @@ -69998,20 +70017,20 @@ paths: parameters: - *308 - *309 - - *170 - *171 - *172 - *173 + - *174 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *174 - - *453 - *175 + - *451 - *176 + - *177 - *46 - name: per_page description: The number of results per page (max 100). For more information, @@ -70030,11 +70049,11 @@ paths: application/json: schema: type: array - items: &456 + items: &454 type: object description: A Dependabot alert. properties: - number: *151 + number: *152 state: type: string description: The state of the Dependabot alert. @@ -70080,13 +70099,13 @@ paths: - direct - transitive - - security_advisory: *454 + security_advisory: *452 security_vulnerability: *50 - url: *154 - html_url: *155 - created_at: *152 - updated_at: *153 - dismissed_at: *157 + url: *155 + html_url: *156 + created_at: *153 + updated_at: *154 + dismissed_at: *158 dismissed_by: anyOf: - type: 'null' @@ -70110,8 +70129,8 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: *156 - auto_dismissed_at: *455 + fixed_at: *157 + auto_dismissed_at: *453 required: - number - state @@ -70343,7 +70362,7 @@ paths: parameters: - *308 - *309 - - &457 + - &455 name: alert_number in: path description: |- @@ -70352,13 +70371,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *151 + schema: *152 responses: '200': description: Response content: application/json: - schema: *456 + schema: *454 examples: default: value: @@ -70473,7 +70492,7 @@ paths: parameters: - *308 - *309 - - *457 + - *455 requestBody: required: true content: @@ -70518,7 +70537,7 @@ paths: description: Response content: application/json: - schema: *456 + schema: *454 examples: default: value: @@ -70666,7 +70685,7 @@ paths: type: integer secrets: type: array - items: &460 + items: &458 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -70727,9 +70746,9 @@ paths: description: Response content: application/json: - schema: *458 + schema: *456 examples: - default: *459 + default: *457 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70751,13 +70770,13 @@ paths: parameters: - *308 - *309 - - *143 + - *144 responses: '200': description: Response content: application/json: - schema: *460 + schema: *458 examples: default: value: @@ -70785,7 +70804,7 @@ paths: parameters: - *308 - *309 - - *143 + - *144 requestBody: required: true content: @@ -70813,7 +70832,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -70839,7 +70858,7 @@ paths: parameters: - *308 - *309 - - *143 + - *144 responses: '204': description: Response @@ -71381,7 +71400,7 @@ paths: - version - url additionalProperties: false - metadata: &461 + metadata: &459 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -71420,7 +71439,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *461 + metadata: *459 resolved: type: object description: A collection of resolved package dependencies. @@ -71434,7 +71453,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *461 + metadata: *459 relationship: type: string description: A notation of whether a dependency is requested @@ -71609,9 +71628,9 @@ paths: application/json: schema: type: array - items: *462 + items: *460 examples: - default: *463 + default: *461 headers: Link: *52 x-github: @@ -71760,7 +71779,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *460 examples: simple-example: summary: Simple example @@ -71835,7 +71854,7 @@ paths: parameters: - *308 - *309 - - &464 + - &462 name: deployment_id description: deployment_id parameter in: path @@ -71847,7 +71866,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *460 examples: default: value: @@ -71914,7 +71933,7 @@ paths: parameters: - *308 - *309 - - *464 + - *462 responses: '204': description: Response @@ -71938,7 +71957,7 @@ paths: parameters: - *308 - *309 - - *464 + - *462 - *17 - *19 responses: @@ -71948,7 +71967,7 @@ paths: application/json: schema: type: array - items: &465 + items: &463 title: Deployment Status description: The status of a deployment. type: object @@ -72114,7 +72133,7 @@ paths: parameters: - *308 - *309 - - *464 + - *462 requestBody: required: true content: @@ -72189,9 +72208,9 @@ paths: description: Response content: application/json: - schema: *465 + schema: *463 examples: - default: &466 + default: &464 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -72249,7 +72268,7 @@ paths: parameters: - *308 - *309 - - *464 + - *462 - name: status_id in: path required: true @@ -72260,9 +72279,9 @@ paths: description: Response content: application/json: - schema: *465 + schema: *463 examples: - default: *466 + default: *464 '404': *6 x-github: githubCloudOnly: false @@ -72364,7 +72383,7 @@ paths: - 5 environments: type: array - items: &468 + items: &466 title: Environment description: Details of a deployment environment type: object @@ -72426,7 +72445,7 @@ paths: type: string examples: - wait_timer - wait_timer: &470 + wait_timer: &468 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -72468,11 +72487,11 @@ paths: items: type: object properties: - type: *467 + type: *465 reviewer: anyOf: - *4 - - *169 + - *170 required: - id - node_id @@ -72495,7 +72514,7 @@ paths: - id - node_id - type - deployment_branch_policy: &471 + deployment_branch_policy: &469 type: - object - 'null' @@ -72614,7 +72633,7 @@ paths: parameters: - *308 - *309 - - &469 + - &467 name: environment_name in: path required: true @@ -72627,9 +72646,9 @@ paths: description: Response content: application/json: - schema: *468 + schema: *466 examples: - default: &472 + default: &470 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -72715,7 +72734,7 @@ paths: parameters: - *308 - *309 - - *469 + - *467 requestBody: required: false content: @@ -72725,7 +72744,7 @@ paths: - object - 'null' properties: - wait_timer: *470 + wait_timer: *468 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -72744,14 +72763,14 @@ paths: items: type: object properties: - type: *467 + type: *465 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *471 + deployment_branch_policy: *469 additionalProperties: false examples: default: @@ -72771,9 +72790,9 @@ paths: description: Response content: application/json: - schema: *468 + schema: *466 examples: - default: *472 + default: *470 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -72799,7 +72818,7 @@ paths: parameters: - *308 - *309 - - *469 + - *467 responses: '204': description: Default response @@ -72826,7 +72845,7 @@ paths: parameters: - *308 - *309 - - *469 + - *467 - *17 - *19 responses: @@ -72845,7 +72864,7 @@ paths: - 2 branch_policies: type: array - items: &473 + items: &471 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -72908,7 +72927,7 @@ paths: parameters: - *308 - *309 - - *469 + - *467 requestBody: required: true content: @@ -72956,9 +72975,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *471 examples: - example-wildcard: &474 + example-wildcard: &472 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -73002,8 +73021,8 @@ paths: parameters: - *308 - *309 - - *469 - - &475 + - *467 + - &473 name: branch_policy_id in: path required: true @@ -73015,9 +73034,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *471 examples: - default: *474 + default: *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73038,8 +73057,8 @@ paths: parameters: - *308 - *309 - - *469 - - *475 + - *467 + - *473 requestBody: required: true content: @@ -73068,9 +73087,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *471 examples: - default: *474 + default: *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73091,8 +73110,8 @@ paths: parameters: - *308 - *309 - - *469 - - *475 + - *467 + - *473 responses: '204': description: Response @@ -73117,7 +73136,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *469 + - *467 - *309 - *308 responses: @@ -73136,7 +73155,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &476 + items: &474 title: Deployment protection rule description: Deployment protection rule type: object @@ -73158,7 +73177,7 @@ paths: for the environment. examples: - true - app: &477 + app: &475 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -73261,7 +73280,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *469 + - *467 - *309 - *308 requestBody: @@ -73284,9 +73303,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *476 + schema: *474 examples: - default: &478 + default: &476 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -73321,7 +73340,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *469 + - *467 - *309 - *308 - *19 @@ -73343,7 +73362,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *477 + items: *475 examples: default: value: @@ -73380,8 +73399,8 @@ paths: parameters: - *308 - *309 - - *469 - - &479 + - *467 + - &477 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -73393,9 +73412,9 @@ paths: description: Response content: application/json: - schema: *476 + schema: *474 examples: - default: *478 + default: *476 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73416,10 +73435,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *469 + - *467 - *309 - *308 - - *479 + - *477 responses: '204': description: Response @@ -73447,7 +73466,7 @@ paths: parameters: - *308 - *309 - - *469 + - *467 - *17 - *19 responses: @@ -73465,9 +73484,9 @@ paths: type: integer secrets: type: array - items: *356 + items: *354 examples: - default: *357 + default: *355 headers: Link: *52 x-github: @@ -73494,15 +73513,15 @@ paths: parameters: - *308 - *309 - - *469 + - *467 responses: '200': description: Response content: application/json: - schema: *358 + schema: *356 examples: - default: *359 + default: *357 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73526,16 +73545,16 @@ paths: parameters: - *308 - *309 - - *469 - - *143 + - *467 + - *144 responses: '200': description: Response content: application/json: - schema: *356 + schema: *354 examples: - default: *480 + default: *478 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73559,8 +73578,8 @@ paths: parameters: - *308 - *309 - - *469 - - *143 + - *467 + - *144 requestBody: required: true content: @@ -73591,7 +73610,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -73619,8 +73638,8 @@ paths: parameters: - *308 - *309 - - *469 - - *143 + - *467 + - *144 responses: '204': description: Default response @@ -73647,8 +73666,8 @@ paths: parameters: - *308 - *309 - - *469 - - *327 + - *467 + - *325 - *19 responses: '200': @@ -73665,9 +73684,9 @@ paths: type: integer variables: type: array - items: *360 + items: *358 examples: - default: *361 + default: *359 headers: Link: *52 x-github: @@ -73692,7 +73711,7 @@ paths: parameters: - *308 - *309 - - *469 + - *467 requestBody: required: true content: @@ -73719,7 +73738,7 @@ paths: description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -73746,16 +73765,16 @@ paths: parameters: - *308 - *309 - - *469 - - *146 + - *467 + - *147 responses: '200': description: Response content: application/json: - schema: *360 + schema: *358 examples: - default: *481 + default: *479 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73778,8 +73797,8 @@ paths: parameters: - *308 - *309 - - *146 - - *469 + - *147 + - *467 requestBody: required: true content: @@ -73823,8 +73842,8 @@ paths: parameters: - *308 - *309 - - *146 - - *469 + - *147 + - *467 responses: '204': description: Response @@ -73938,7 +73957,7 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: default: value: @@ -74109,9 +74128,9 @@ paths: description: Response content: application/json: - schema: *316 + schema: *314 examples: - default: *318 + default: *316 '400': *14 '422': *15 '403': *27 @@ -74192,8 +74211,8 @@ paths: application/json: schema: oneOf: - - *104 - - *482 + - *105 + - *480 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74429,7 +74448,7 @@ paths: description: Response content: application/json: - schema: &483 + schema: &481 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -74658,13 +74677,13 @@ paths: parameters: - *308 - *309 - - *439 + - *437 responses: '200': description: Response content: application/json: - schema: *483 + schema: *481 examples: default: value: @@ -74722,7 +74741,7 @@ paths: parameters: - *308 - *309 - - &484 + - &482 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. @@ -74739,7 +74758,7 @@ paths: application/json: schema: type: array - items: &485 + items: &483 title: Git Reference description: Git references within a repository type: object @@ -74817,15 +74836,15 @@ paths: parameters: - *308 - *309 - - *484 + - *482 responses: '200': description: Response content: application/json: - schema: *485 + schema: *483 examples: - default: &486 + default: &484 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -74884,9 +74903,9 @@ paths: description: Response content: application/json: - schema: *485 + schema: *483 examples: - default: *486 + default: *484 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -74914,7 +74933,7 @@ paths: parameters: - *308 - *309 - - *484 + - *482 requestBody: required: true content: @@ -74943,9 +74962,9 @@ paths: description: Response content: application/json: - schema: *485 + schema: *483 examples: - default: *486 + default: *484 '422': *15 '409': *45 x-github: @@ -74965,7 +74984,7 @@ paths: parameters: - *308 - *309 - - *484 + - *482 responses: '204': description: Response @@ -75088,7 +75107,7 @@ paths: description: Response content: application/json: - schema: &488 + schema: &486 title: Git Tag description: Metadata for a Git tag type: object @@ -75144,7 +75163,7 @@ paths: - sha - type - url - verification: *487 + verification: *485 required: - sha - url @@ -75154,7 +75173,7 @@ paths: - tag - message examples: - default: &489 + default: &487 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -75239,9 +75258,9 @@ paths: description: Response content: application/json: - schema: *488 + schema: *486 examples: - default: *489 + default: *487 '404': *6 '409': *45 x-github: @@ -75340,7 +75359,7 @@ paths: description: Response content: application/json: - schema: &490 + schema: &488 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -75466,7 +75485,7 @@ paths: description: Response content: application/json: - schema: *490 + schema: *488 examples: default-response: summary: Default response @@ -75536,7 +75555,7 @@ paths: application/json: schema: type: array - items: &491 + items: &489 title: Webhook description: Webhooks for repositories. type: object @@ -75599,7 +75618,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &725 + last_response: &724 title: Hook Response type: object properties: @@ -75730,9 +75749,9 @@ paths: description: Response content: application/json: - schema: *491 + schema: *489 examples: - default: &492 + default: &490 value: type: Repository id: 12345678 @@ -75782,15 +75801,15 @@ paths: parameters: - *308 - *309 - - *182 + - *183 responses: '200': description: Response content: application/json: - schema: *491 + schema: *489 examples: - default: *492 + default: *490 '404': *6 x-github: githubCloudOnly: false @@ -75812,7 +75831,7 @@ paths: parameters: - *308 - *309 - - *182 + - *183 requestBody: required: true content: @@ -75857,9 +75876,9 @@ paths: description: Response content: application/json: - schema: *491 + schema: *489 examples: - default: *492 + default: *490 '422': *15 '404': *6 x-github: @@ -75882,7 +75901,7 @@ paths: parameters: - *308 - *309 - - *182 + - *183 responses: '204': description: Response @@ -75908,7 +75927,7 @@ paths: parameters: - *308 - *309 - - *182 + - *183 responses: '200': description: Response @@ -75937,7 +75956,7 @@ paths: parameters: - *308 - *309 - - *182 + - *183 requestBody: required: false content: @@ -75983,9 +76002,9 @@ paths: parameters: - *308 - *309 - - *182 - - *17 - *183 + - *17 + - *184 responses: '200': description: Response @@ -75993,9 +76012,9 @@ paths: application/json: schema: type: array - items: *184 + items: *185 examples: - default: *185 + default: *186 '400': *14 '422': *15 x-github: @@ -76016,16 +76035,16 @@ paths: parameters: - *308 - *309 - - *182 + - *183 - *16 responses: '200': description: Response content: application/json: - schema: *186 + schema: *187 examples: - default: *187 + default: *188 '400': *14 '422': *15 x-github: @@ -76046,7 +76065,7 @@ paths: parameters: - *308 - *309 - - *182 + - *183 - *16 responses: '202': *37 @@ -76071,7 +76090,7 @@ paths: parameters: - *308 - *309 - - *182 + - *183 responses: '204': description: Response @@ -76098,7 +76117,7 @@ paths: parameters: - *308 - *309 - - *182 + - *183 responses: '204': description: Response @@ -76173,7 +76192,7 @@ paths: - *308 - *309 responses: - '204': *165 + '204': *166 '409': *45 x-github: githubCloudOnly: false @@ -76194,7 +76213,7 @@ paths: - *308 - *309 responses: - '204': *165 + '204': *166 '409': *45 x-github: githubCloudOnly: false @@ -76256,7 +76275,7 @@ paths: description: Response content: application/json: - schema: &493 + schema: &491 title: Import description: A repository import from an external source. type: object @@ -76363,7 +76382,7 @@ paths: - html_url - authors_url examples: - default: &496 + default: &494 value: vcs: subversion use_lfs: true @@ -76379,7 +76398,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': &494 + '503': &492 description: Unavailable due to service under maintenance. content: application/json: @@ -76457,7 +76476,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *491 examples: default: value: @@ -76482,7 +76501,7 @@ paths: type: string '422': *15 '404': *6 - '503': *494 + '503': *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76563,7 +76582,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *491 examples: example-1: summary: Example 1 @@ -76611,7 +76630,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': *494 + '503': *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76639,7 +76658,7 @@ paths: responses: '204': description: Response - '503': *494 + '503': *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76667,7 +76686,7 @@ paths: parameters: - *308 - *309 - - &664 + - &663 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -76681,7 +76700,7 @@ paths: application/json: schema: type: array - items: &495 + items: &493 title: Porter Author description: Porter Author type: object @@ -76735,7 +76754,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': *494 + '503': *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76791,7 +76810,7 @@ paths: description: Response content: application/json: - schema: *495 + schema: *493 examples: default: value: @@ -76804,7 +76823,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *494 + '503': *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76870,7 +76889,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *494 + '503': *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76926,11 +76945,11 @@ paths: description: Response content: application/json: - schema: *493 + schema: *491 examples: - default: *496 + default: *494 '422': *15 - '503': *494 + '503': *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76962,8 +76981,8 @@ paths: application/json: schema: *20 examples: - default: *497 - '301': *317 + default: *495 + '301': *315 '404': *6 x-github: githubCloudOnly: false @@ -76992,12 +77011,12 @@ paths: application/json: schema: anyOf: - - *200 + - *201 - type: object properties: {} additionalProperties: false examples: - default: &499 + default: &497 value: limit: collaborators_only origin: repository @@ -77028,7 +77047,7 @@ paths: required: true content: application/json: - schema: *498 + schema: *496 examples: default: summary: Example request body @@ -77040,9 +77059,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *201 examples: - default: *499 + default: *497 '409': description: Response x-github: @@ -77099,9 +77118,9 @@ paths: application/json: schema: type: array - items: *500 + items: *498 examples: - default: &657 + default: &656 value: - id: 1 repository: @@ -77234,7 +77253,7 @@ paths: parameters: - *308 - *309 - - *204 + - *205 requestBody: required: false content: @@ -77263,7 +77282,7 @@ paths: description: Response content: application/json: - schema: *500 + schema: *498 examples: default: value: @@ -77396,7 +77415,7 @@ paths: parameters: - *308 - *309 - - *204 + - *205 responses: '204': description: Response @@ -77476,7 +77495,7 @@ paths: required: false schema: type: string - - *208 + - *209 - name: sort description: What to sort results by. in: query @@ -77501,7 +77520,7 @@ paths: type: array items: *78 examples: - default: &507 + default: &506 value: - id: 1 node_id: MDU6SXNzdWUx @@ -77649,7 +77668,7 @@ paths: state_reason: completed headers: Link: *52 - '301': *317 + '301': *315 '422': *15 '404': *6 x-github: @@ -77771,7 +77790,7 @@ paths: application/json: schema: *78 examples: - default: &504 + default: &503 value: id: 1 node_id: MDU6SXNzdWUx @@ -77927,7 +77946,7 @@ paths: '422': *15 '503': *97 '404': *6 - '410': *314 + '410': *499 x-github: triggersNotification: true githubCloudOnly: false @@ -77977,9 +77996,9 @@ paths: application/json: schema: type: array - items: *501 + items: *500 examples: - default: &506 + default: &505 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -78045,9 +78064,9 @@ paths: description: Response content: application/json: - schema: *501 + schema: *500 examples: - default: &502 + default: &501 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -78125,9 +78144,9 @@ paths: description: Response content: application/json: - schema: *501 + schema: *500 examples: - default: *502 + default: *501 '422': *15 x-github: githubCloudOnly: false @@ -78317,7 +78336,7 @@ paths: application/json: schema: type: array - items: &503 + items: &502 title: Issue Event description: Issue Event type: object @@ -78397,7 +78416,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *169 + requested_team: *170 dismissed_review: title: Issue Event Dismissed Review type: object @@ -78668,7 +78687,7 @@ paths: description: Response content: application/json: - schema: *503 + schema: *502 examples: default: value: @@ -78861,7 +78880,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *314 + '410': *499 '403': *27 x-github: githubCloudOnly: false @@ -78897,7 +78916,7 @@ paths: parameters: - *308 - *309 - - &505 + - &504 name: issue_number description: The number that identifies the issue. in: path @@ -78911,10 +78930,10 @@ paths: application/json: schema: *78 examples: - default: *504 - '301': *317 + default: *503 + '301': *315 '404': *6 - '410': *314 + '410': *499 '304': *35 x-github: githubCloudOnly: false @@ -78941,7 +78960,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: false content: @@ -79062,13 +79081,13 @@ paths: application/json: schema: *78 examples: - default: *504 + default: *503 '422': *15 '503': *97 '403': *27 - '301': *317 + '301': *315 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79088,7 +79107,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: false content: @@ -79116,7 +79135,7 @@ paths: application/json: schema: *78 examples: - default: *504 + default: *503 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79134,7 +79153,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: content: application/json: @@ -79161,7 +79180,7 @@ paths: application/json: schema: *78 examples: - default: *504 + default: *503 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79185,7 +79204,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - name: assignee in: path required: true @@ -79227,7 +79246,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - *68 - *17 - *19 @@ -79238,13 +79257,13 @@ paths: application/json: schema: type: array - items: *501 + items: *500 examples: - default: *506 + default: *505 headers: Link: *52 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79275,7 +79294,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: true content: @@ -79297,16 +79316,16 @@ paths: description: Response content: application/json: - schema: *501 + schema: *500 examples: - default: *502 + default: *501 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *314 + '410': *499 '422': *15 '404': *6 x-github: @@ -79336,7 +79355,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - *17 - *19 responses: @@ -79348,12 +79367,12 @@ paths: type: array items: *78 examples: - default: *507 + default: *506 headers: Link: *52 - '301': *317 + '301': *315 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79383,7 +79402,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: true content: @@ -79407,15 +79426,15 @@ paths: application/json: schema: *78 examples: - default: *504 + default: *503 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *317 + '301': *315 '403': *27 - '410': *314 + '410': *499 '422': *15 '404': *6 x-github: @@ -79448,7 +79467,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -79462,13 +79481,13 @@ paths: application/json: schema: *78 examples: - default: *504 - '301': *317 + default: *503 + '301': *315 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *314 + '410': *499 x-github: triggersNotification: true githubCloudOnly: false @@ -79496,7 +79515,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - *17 - *19 responses: @@ -79508,12 +79527,12 @@ paths: type: array items: *78 examples: - default: *507 + default: *506 headers: Link: *52 - '301': *317 + '301': *315 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79532,7 +79551,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - *17 - *19 responses: @@ -79546,7 +79565,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &510 + - &509 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -79595,7 +79614,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &511 + - &510 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -79723,7 +79742,7 @@ paths: - performed_via_github_app - assignee - assigner - - &512 + - &511 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -79769,7 +79788,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &513 + - &512 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -79815,7 +79834,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &514 + - &513 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -79864,7 +79883,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &515 + - &514 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -79893,7 +79912,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *169 + requested_team: *170 requested_reviewer: *4 required: - review_requester @@ -79906,7 +79925,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &516 + - &515 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -79935,7 +79954,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *169 + requested_team: *170 requested_reviewer: *4 required: - review_requester @@ -79948,7 +79967,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &517 + - &516 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -80004,7 +80023,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &518 + - &517 title: Locked Issue Event description: Locked Issue Event type: object @@ -80049,7 +80068,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &519 + - &518 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -80110,7 +80129,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &520 + - &519 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -80171,7 +80190,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &521 + - &520 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -80232,7 +80251,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &522 + - &521 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -80325,7 +80344,7 @@ paths: color: red headers: Link: *52 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80344,7 +80363,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - *17 - *19 responses: @@ -80354,7 +80373,7 @@ paths: application/json: schema: type: array - items: &508 + items: &507 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -80409,7 +80428,7 @@ paths: - color - default examples: - default: &509 + default: &508 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -80427,9 +80446,9 @@ paths: default: false headers: Link: *52 - '301': *317 + '301': *315 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80448,7 +80467,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: false content: @@ -80507,12 +80526,12 @@ paths: application/json: schema: type: array - items: *508 + items: *507 examples: - default: *509 - '301': *317 + default: *508 + '301': *315 '404': *6 - '410': *314 + '410': *499 '422': *15 x-github: githubCloudOnly: false @@ -80531,7 +80550,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: false content: @@ -80591,12 +80610,12 @@ paths: application/json: schema: type: array - items: *508 + items: *507 examples: - default: *509 - '301': *317 + default: *508 + '301': *315 '404': *6 - '410': *314 + '410': *499 '422': *15 x-github: githubCloudOnly: false @@ -80615,13 +80634,13 @@ paths: parameters: - *308 - *309 - - *505 + - *504 responses: '204': description: Response - '301': *317 + '301': *315 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80642,7 +80661,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - name: name in: path required: true @@ -80655,7 +80674,7 @@ paths: application/json: schema: type: array - items: *508 + items: *507 examples: default: value: @@ -80666,9 +80685,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *317 + '301': *315 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80690,7 +80709,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: false content: @@ -80719,7 +80738,7 @@ paths: '204': description: Response '403': *27 - '410': *314 + '410': *499 '404': *6 '422': *15 x-github: @@ -80739,7 +80758,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 responses: '204': description: Response @@ -80771,7 +80790,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 responses: '200': description: Response @@ -80779,10 +80798,10 @@ paths: application/json: schema: *78 examples: - default: *504 - '301': *317 + default: *503 + '301': *315 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80801,7 +80820,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - 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. @@ -80833,7 +80852,7 @@ paths: headers: Link: *52 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80853,7 +80872,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: true content: @@ -80918,7 +80937,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - *304 responses: '204': @@ -80950,7 +80969,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: true content: @@ -80974,7 +80993,7 @@ paths: application/json: schema: *78 examples: - default: *504 + default: *503 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -81009,7 +81028,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - *17 - *19 responses: @@ -81021,11 +81040,11 @@ paths: type: array items: *78 examples: - default: *507 + default: *506 headers: Link: *52 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81055,7 +81074,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: true content: @@ -81084,14 +81103,14 @@ paths: application/json: schema: *78 examples: - default: *504 + default: *503 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *314 + '410': *499 '422': *15 '404': *6 x-github: @@ -81113,7 +81132,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: true content: @@ -81146,7 +81165,7 @@ paths: application/json: schema: *78 examples: - default: *504 + default: *503 '403': *27 '404': *6 '422': *7 @@ -81170,7 +81189,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - *17 - *19 responses: @@ -81185,6 +81204,7 @@ paths: description: Timeline Event type: object anyOf: + - *509 - *510 - *511 - *512 @@ -81197,7 +81217,6 @@ paths: - *519 - *520 - *521 - - *522 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -81526,7 +81545,7 @@ paths: type: string comments: type: array - items: &543 + items: &542 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -81764,7 +81783,7 @@ paths: type: string comments: type: array - items: *437 + items: *435 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -82039,7 +82058,7 @@ paths: headers: Link: *52 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82067,7 +82086,7 @@ paths: application/json: schema: type: array - items: &523 + items: &522 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -82172,9 +82191,9 @@ paths: description: Response content: application/json: - schema: *523 + schema: *522 examples: - default: &524 + default: &523 value: id: 1 key: ssh-rsa AAA... @@ -82210,7 +82229,7 @@ paths: parameters: - *308 - *309 - - &525 + - &524 name: key_id description: The unique identifier of the key. in: path @@ -82222,9 +82241,9 @@ paths: description: Response content: application/json: - schema: *523 + schema: *522 examples: - default: *524 + default: *523 '404': *6 x-github: githubCloudOnly: false @@ -82244,7 +82263,7 @@ paths: parameters: - *308 - *309 - - *525 + - *524 responses: '204': description: Response @@ -82275,9 +82294,9 @@ paths: application/json: schema: type: array - items: *508 + items: *507 examples: - default: *509 + default: *508 headers: Link: *52 '404': *6 @@ -82335,9 +82354,9 @@ paths: description: Response content: application/json: - schema: *508 + schema: *507 examples: - default: &526 + default: &525 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -82381,9 +82400,9 @@ paths: description: Response content: application/json: - schema: *508 + schema: *507 examples: - default: *526 + default: *525 '404': *6 x-github: githubCloudOnly: false @@ -82440,7 +82459,7 @@ paths: description: Response content: application/json: - schema: *508 + schema: *507 examples: default: value: @@ -82535,7 +82554,7 @@ paths: parameters: - *308 - *309 - - *415 + - *413 responses: '200': description: Response @@ -82783,9 +82802,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *438 + schema: *436 examples: - default: *527 + default: *526 '204': description: Response when already merged '404': @@ -82951,7 +82970,7 @@ paths: application/json: schema: *243 examples: - default: &528 + default: &527 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -83012,7 +83031,7 @@ paths: parameters: - *308 - *309 - - &529 + - &528 name: milestone_number description: The number that identifies the milestone. in: path @@ -83026,7 +83045,7 @@ paths: application/json: schema: *243 examples: - default: *528 + default: *527 '404': *6 x-github: githubCloudOnly: false @@ -83045,7 +83064,7 @@ paths: parameters: - *308 - *309 - - *529 + - *528 requestBody: required: false content: @@ -83085,7 +83104,7 @@ paths: application/json: schema: *243 examples: - default: *528 + default: *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83103,7 +83122,7 @@ paths: parameters: - *308 - *309 - - *529 + - *528 responses: '204': description: Response @@ -83126,7 +83145,7 @@ paths: parameters: - *308 - *309 - - *529 + - *528 - *17 - *19 responses: @@ -83136,9 +83155,9 @@ paths: application/json: schema: type: array - items: *508 + items: *507 examples: - default: *509 + default: *508 headers: Link: *52 x-github: @@ -83159,10 +83178,10 @@ paths: parameters: - *308 - *309 + - *529 - *530 - - *531 - *68 - - *532 + - *531 - *17 - *19 responses: @@ -83174,7 +83193,7 @@ paths: type: array items: *90 examples: - default: *533 + default: *532 headers: Link: *52 x-github: @@ -83264,7 +83283,7 @@ paths: description: Response content: application/json: - schema: &534 + schema: &533 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -83408,7 +83427,7 @@ paths: - custom_404 - public examples: - default: &535 + default: &534 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -83505,9 +83524,9 @@ paths: description: Response content: application/json: - schema: *534 + schema: *533 examples: - default: *535 + default: *534 '422': *15 '409': *45 x-github: @@ -83669,7 +83688,7 @@ paths: application/json: schema: type: array - items: &536 + items: &535 title: Page Build description: Page Build type: object @@ -83816,9 +83835,9 @@ paths: description: Response content: application/json: - schema: *536 + schema: *535 examples: - default: &537 + default: &536 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -83878,9 +83897,9 @@ paths: description: Response content: application/json: - schema: *536 + schema: *535 examples: - default: *537 + default: *536 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84011,7 +84030,7 @@ paths: parameters: - *308 - *309 - - &538 + - &537 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -84071,9 +84090,9 @@ paths: parameters: - *308 - *309 - - *538 + - *537 responses: - '204': *165 + '204': *166 '404': *6 x-github: githubCloudOnly: false @@ -84367,7 +84386,7 @@ paths: description: Empty response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -84435,7 +84454,7 @@ paths: - *308 - *309 responses: - '204': *165 + '204': *166 '422': *14 x-github: githubCloudOnly: false @@ -84457,155 +84476,13 @@ paths: - *308 - *309 responses: - '204': *165 + '204': *166 '422': *14 x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos - "/repos/{owner}/{repo}/projects": - get: - summary: List repository 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: - - projects-classic - operationId: projects-classic/list-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#list-repository-projects - parameters: - - *308 - - *309 - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *238 - examples: - default: - value: - - owner_url: https://api.github.com/repos/api-playground/projects-test - url: https://api.github.com/projects/1002604 - html_url: https://github.com/api-playground/projects-test/projects/1 - columns_url: https://api.github.com/projects/1002604/columns - id: 1002604 - node_id: MDc6UHJvamVjdDEwMDI2MDQ= - name: Projects Documentation - body: Developer documentation project for the developer site. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - headers: - Link: *52 - '401': *23 - '403': *27 - '404': *6 - '410': *314 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create a repository 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: - - projects-classic - operationId: projects-classic/create-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#create-a-repository-project - parameters: - - *308 - - *309 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the project. - body: - type: string - description: The description of the project. - required: - - name - examples: - default: - value: - name: Projects Documentation - body: Developer documentation project for the developer site. - responses: - '201': - description: Response - content: - application/json: - schema: *238 - examples: - default: *313 - '401': *23 - '403': *27 - '404': *6 - '410': *314 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/repos/{owner}/{repo}/properties/values": get: summary: Get all custom property values for a repository @@ -84630,7 +84507,7 @@ paths: type: array items: *95 examples: - default: *539 + default: *538 '403': *27 '404': *6 x-github: @@ -84669,7 +84546,7 @@ paths: required: - properties examples: - default: *540 + default: *539 responses: '204': description: No Content when custom property values are successfully created @@ -84768,9 +84645,9 @@ paths: application/json: schema: type: array - items: *442 + items: *440 examples: - default: *541 + default: *540 headers: Link: *52 '304': *35 @@ -84870,7 +84747,7 @@ paths: description: Response content: application/json: - schema: &545 + schema: &544 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -85054,7 +84931,7 @@ paths: type: - array - 'null' - items: *220 + items: *221 head: type: object properties: @@ -85110,7 +84987,7 @@ paths: - review_comment - self author_association: *65 - auto_merge: *542 + auto_merge: *541 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -85212,7 +85089,7 @@ paths: - merged_by - review_comments examples: - default: &546 + default: &545 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -85769,9 +85646,9 @@ paths: application/json: schema: type: array - items: *543 + items: *542 examples: - default: &548 + default: &547 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -85856,9 +85733,9 @@ paths: description: Response content: application/json: - schema: *543 + schema: *542 examples: - default: &544 + default: &543 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -85957,9 +85834,9 @@ paths: description: Response content: application/json: - schema: *543 + schema: *542 examples: - default: *544 + default: *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86162,7 +86039,7 @@ paths: parameters: - *308 - *309 - - &547 + - &546 name: pull_number description: The number that identifies the pull request. in: path @@ -86175,9 +86052,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *545 + schema: *544 examples: - default: *546 + default: *545 '304': *35 '404': *6 '406': @@ -86214,7 +86091,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 requestBody: required: false content: @@ -86256,9 +86133,9 @@ paths: description: Response content: application/json: - schema: *545 + schema: *544 examples: - default: *546 + default: *545 '422': *15 '403': *27 x-github: @@ -86282,7 +86159,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 requestBody: required: true content: @@ -86343,17 +86220,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '401': *23 '403': *27 '404': *6 @@ -86385,7 +86262,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 - *87 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -86406,9 +86283,9 @@ paths: application/json: schema: type: array - items: *543 + items: *542 examples: - default: *548 + default: *547 headers: Link: *52 x-github: @@ -86443,7 +86320,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 requestBody: required: true content: @@ -86549,7 +86426,7 @@ paths: description: Response content: application/json: - schema: *543 + schema: *542 examples: example-for-a-multi-line-comment: value: @@ -86639,7 +86516,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 - *77 requestBody: required: true @@ -86662,7 +86539,7 @@ paths: description: Response content: application/json: - schema: *543 + schema: *542 examples: default: value: @@ -86750,7 +86627,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 - *17 - *19 responses: @@ -86760,9 +86637,9 @@ paths: application/json: schema: type: array - items: *438 + items: *436 examples: - default: *549 + default: *548 headers: Link: *52 x-github: @@ -86794,7 +86671,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 - *17 - *19 responses: @@ -86804,7 +86681,7 @@ paths: application/json: schema: type: array - items: *449 + items: *447 examples: default: value: @@ -86844,7 +86721,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 responses: '204': description: Response if pull request has been merged @@ -86869,7 +86746,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 requestBody: required: false content: @@ -86983,7 +86860,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 responses: '200': description: Response @@ -86999,7 +86876,7 @@ paths: items: *4 teams: type: array - items: *169 + items: *170 required: - users - teams @@ -87060,7 +86937,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 requestBody: required: false content: @@ -87097,7 +86974,7 @@ paths: description: Response content: application/json: - schema: *442 + schema: *440 examples: default: value: @@ -87635,7 +87512,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 requestBody: required: true content: @@ -87669,7 +87546,7 @@ paths: description: Response content: application/json: - schema: *442 + schema: *440 examples: default: value: @@ -88176,7 +88053,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 - *17 - *19 responses: @@ -88186,7 +88063,7 @@ paths: application/json: schema: type: array - items: &550 + items: &549 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -88344,7 +88221,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 requestBody: required: false content: @@ -88434,9 +88311,9 @@ paths: description: Response content: application/json: - schema: *550 + schema: *549 examples: - default: &552 + default: &551 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -88501,8 +88378,8 @@ paths: parameters: - *308 - *309 - - *547 - - &551 + - *546 + - &550 name: review_id description: The unique identifier of the review. in: path @@ -88514,9 +88391,9 @@ paths: description: Response content: application/json: - schema: *550 + schema: *549 examples: - default: &553 + default: &552 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -88577,8 +88454,8 @@ paths: parameters: - *308 - *309 - - *547 - - *551 + - *546 + - *550 requestBody: required: true content: @@ -88601,7 +88478,7 @@ paths: description: Response content: application/json: - schema: *550 + schema: *549 examples: default: value: @@ -88665,16 +88542,16 @@ paths: parameters: - *308 - *309 - - *547 - - *551 + - *546 + - *550 responses: '200': description: Response content: application/json: - schema: *550 + schema: *549 examples: - default: *552 + default: *551 '422': *7 '404': *6 x-github: @@ -88703,8 +88580,8 @@ paths: parameters: - *308 - *309 - - *547 - - *551 + - *546 + - *550 - *17 - *19 responses: @@ -88964,8 +88841,8 @@ paths: parameters: - *308 - *309 - - *547 - - *551 + - *546 + - *550 requestBody: required: true content: @@ -88994,7 +88871,7 @@ paths: description: Response content: application/json: - schema: *550 + schema: *549 examples: default: value: @@ -89059,8 +88936,8 @@ paths: parameters: - *308 - *309 - - *547 - - *551 + - *546 + - *550 requestBody: required: true content: @@ -89095,9 +88972,9 @@ paths: description: Response content: application/json: - schema: *550 + schema: *549 examples: - default: *553 + default: *552 '404': *6 '422': *7 '403': *27 @@ -89121,7 +88998,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 requestBody: required: false content: @@ -89199,9 +89076,9 @@ paths: description: Response content: application/json: - schema: *554 + schema: *553 examples: - default: &555 + default: &554 value: type: file encoding: base64 @@ -89264,9 +89141,9 @@ paths: description: Response content: application/json: - schema: *554 + schema: *553 examples: - default: *555 + default: *554 '404': *6 '422': *15 x-github: @@ -89299,7 +89176,7 @@ paths: application/json: schema: type: array - items: &556 + items: &555 title: Release description: A release. type: object @@ -89381,7 +89258,7 @@ paths: author: *4 assets: type: array - items: &557 + items: &556 title: Release Asset description: Data related to a release. type: object @@ -89645,9 +89522,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *555 examples: - default: &560 + default: &559 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -89754,7 +89631,7 @@ paths: parameters: - *308 - *309 - - &558 + - &557 name: asset_id description: The unique identifier of the asset. in: path @@ -89766,9 +89643,9 @@ paths: description: Response content: application/json: - schema: *557 + schema: *556 examples: - default: &559 + default: &558 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -89803,7 +89680,7 @@ paths: type: User site_admin: false '404': *6 - '302': *451 + '302': *449 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89821,7 +89698,7 @@ paths: parameters: - *308 - *309 - - *558 + - *557 requestBody: required: false content: @@ -89850,9 +89727,9 @@ paths: description: Response content: application/json: - schema: *557 + schema: *556 examples: - default: *559 + default: *558 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89870,7 +89747,7 @@ paths: parameters: - *308 - *309 - - *558 + - *557 responses: '204': description: Response @@ -89988,9 +89865,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *555 examples: - default: *560 + default: *559 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90021,9 +89898,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *555 examples: - default: *560 + default: *559 '404': *6 x-github: githubCloudOnly: false @@ -90047,7 +89924,7 @@ paths: parameters: - *308 - *309 - - &561 + - &560 name: release_id description: The unique identifier of the release. in: path @@ -90061,9 +89938,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: *556 + schema: *555 examples: - default: *560 + default: *559 '401': description: Unauthorized x-github: @@ -90083,7 +89960,7 @@ paths: parameters: - *308 - *309 - - *561 + - *560 requestBody: required: false content: @@ -90147,9 +90024,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *555 examples: - default: *560 + default: *559 '404': description: Not Found if the discussion category name is invalid content: @@ -90172,7 +90049,7 @@ paths: parameters: - *308 - *309 - - *561 + - *560 responses: '204': description: Response @@ -90194,7 +90071,7 @@ paths: parameters: - *308 - *309 - - *561 + - *560 - *17 - *19 responses: @@ -90204,7 +90081,7 @@ paths: application/json: schema: type: array - items: *557 + items: *556 examples: default: value: @@ -90287,7 +90164,7 @@ paths: parameters: - *308 - *309 - - *561 + - *560 - name: name in: query required: true @@ -90313,7 +90190,7 @@ paths: description: Response for successful upload content: application/json: - schema: *557 + schema: *556 examples: response-for-successful-upload: value: @@ -90370,7 +90247,7 @@ paths: parameters: - *308 - *309 - - *561 + - *560 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -90419,7 +90296,7 @@ paths: parameters: - *308 - *309 - - *561 + - *560 requestBody: required: true content: @@ -90482,7 +90359,7 @@ paths: parameters: - *308 - *309 - - *561 + - *560 - *304 responses: '204': @@ -90509,7 +90386,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 - *17 - *19 responses: @@ -90526,7 +90403,7 @@ paths: oneOf: - allOf: - *260 - - &562 + - &561 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -90547,67 +90424,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *261 - - *562 + - *561 - allOf: - *262 - - *562 + - *561 - allOf: - *263 - - *562 + - *561 - allOf: - - *563 - *562 + - *561 - allOf: - *264 - - *562 + - *561 - allOf: - *265 - - *562 + - *561 - allOf: - *266 - - *562 + - *561 - allOf: - *267 - - *562 + - *561 - allOf: - *268 - - *562 + - *561 - allOf: - *269 - - *562 + - *561 - allOf: - *270 - - *562 + - *561 - allOf: - *271 - - *562 + - *561 - allOf: - *272 - - *562 + - *561 - allOf: - *273 - - *562 + - *561 - allOf: - *274 - - *562 + - *561 - allOf: - *275 - - *562 + - *561 - allOf: - *276 - - *562 + - *561 - allOf: - *277 - - *562 + - *561 - allOf: - *278 - - *562 + - *561 - allOf: - *279 - - *562 + - *561 - allOf: - - *564 - - *562 + - *563 + - *561 examples: default: value: @@ -90658,7 +90535,7 @@ paths: schema: type: boolean default: true - - *565 + - *564 responses: '200': description: Response @@ -90743,7 +90620,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *566 + items: *565 required: - name - enforcement @@ -90776,7 +90653,7 @@ paths: application/json: schema: *280 examples: - default: &576 + default: &575 value: id: 42 name: super cool ruleset @@ -90825,10 +90702,10 @@ paths: parameters: - *308 - *309 + - *566 - *567 - *568 - *569 - - *570 - *17 - *19 responses: @@ -90836,9 +90713,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *570 examples: - default: *572 + default: *571 '404': *6 '500': *96 x-github: @@ -90861,15 +90738,15 @@ paths: parameters: - *308 - *309 - - *573 + - *572 responses: '200': description: Response content: application/json: - schema: *574 + schema: *573 examples: - default: *575 + default: *574 '404': *6 '500': *96 x-github: @@ -90920,7 +90797,7 @@ paths: application/json: schema: *280 examples: - default: *576 + default: *575 '404': *6 '500': *96 put: @@ -90973,7 +90850,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *566 + items: *565 examples: default: value: @@ -91003,7 +90880,7 @@ paths: application/json: schema: *280 examples: - default: *576 + default: *575 '404': *6 '500': *96 delete: @@ -91064,7 +90941,7 @@ paths: type: array items: *283 examples: - default: *577 + default: *576 '404': *6 '500': *96 x-github: @@ -91102,7 +90979,7 @@ paths: description: Response content: application/json: - schema: *578 + schema: *577 examples: default: value: @@ -91159,19 +91036,19 @@ paths: parameters: - *308 - *309 + - *578 - *579 - *580 - *581 - - *582 - *46 - *19 - *17 + - *582 - *583 - *584 - *585 - *586 - *587 - - *588 responses: '200': description: Response @@ -91179,24 +91056,24 @@ paths: application/json: schema: type: array - items: &592 + items: &591 type: object properties: - number: *151 - created_at: *152 + number: *152 + created_at: *153 updated_at: anyOf: - type: 'null' - - *153 - url: *154 - html_url: *155 + - *154 + url: *155 + html_url: *156 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *589 - resolution: *590 + state: *588 + resolution: *589 resolved_at: type: - string @@ -91290,7 +91167,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *591 + - *590 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -91437,14 +91314,14 @@ paths: parameters: - *308 - *309 - - *409 - - *588 + - *407 + - *587 responses: '200': description: Response content: application/json: - schema: *592 + schema: *591 examples: default: value: @@ -91498,7 +91375,7 @@ paths: parameters: - *308 - *309 - - *409 + - *407 requestBody: required: true content: @@ -91506,16 +91383,17 @@ paths: schema: type: object properties: - state: *589 - resolution: *590 + state: *588 + resolution: *589 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: - string - 'null' - required: - - state + anyOf: + - required: + - state examples: default: value: @@ -91526,7 +91404,7 @@ paths: description: Response content: application/json: - schema: *592 + schema: *591 examples: default: value: @@ -91603,7 +91481,7 @@ paths: parameters: - *308 - *309 - - *409 + - *407 - *19 - *17 responses: @@ -91614,7 +91492,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &745 + items: &744 type: object properties: type: @@ -91641,6 +91519,7 @@ paths: - commit details: oneOf: + - *592 - *593 - *594 - *595 @@ -91653,7 +91532,6 @@ paths: - *602 - *603 - *604 - - *605 examples: default: value: @@ -91748,14 +91626,14 @@ paths: schema: type: object properties: - reason: &607 + reason: &606 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *606 + placeholder_id: *605 required: - reason - placeholder_id @@ -91772,7 +91650,7 @@ paths: schema: type: object properties: - reason: *607 + reason: *606 expire_at: type: - string @@ -91835,7 +91713,7 @@ paths: properties: incremental_scans: type: array - items: &608 + items: &607 description: Information on a single scan performed by secret scanning on the repository type: object @@ -91863,15 +91741,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *608 + items: *607 backfill_scans: type: array - items: *608 + items: *607 custom_pattern_backfill_scans: type: array items: allOf: - - *608 + - *607 - type: object properties: pattern_name: @@ -91986,9 +91864,9 @@ paths: application/json: schema: type: array - items: *609 + items: *608 examples: - default: *610 + default: *609 '400': *14 '404': *6 x-github: @@ -92182,9 +92060,9 @@ paths: description: Response content: application/json: - schema: *609 + schema: *608 examples: - default: &612 + default: &611 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -92531,7 +92409,7 @@ paths: description: Response content: application/json: - schema: *609 + schema: *608 examples: default: value: @@ -92680,15 +92558,15 @@ paths: parameters: - *308 - *309 - - *611 + - *610 responses: '200': description: Response content: application/json: - schema: *609 + schema: *608 examples: - default: *612 + default: *611 '403': *27 '404': *6 x-github: @@ -92714,7 +92592,7 @@ paths: parameters: - *308 - *309 - - *611 + - *610 requestBody: required: true content: @@ -92885,17 +92763,17 @@ paths: description: Response content: application/json: - schema: *609 + schema: *608 examples: - default: *612 - add_credit: *612 + default: *611 + add_credit: *611 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *104 + schema: *105 examples: invalid_state_transition: value: @@ -92928,7 +92806,7 @@ paths: parameters: - *308 - *309 - - *611 + - *610 responses: '202': *37 '400': *14 @@ -92957,15 +92835,15 @@ paths: parameters: - *308 - *309 - - *611 + - *610 responses: '202': description: Response content: application/json: - schema: *316 + schema: *314 examples: - default: *318 + default: *316 '400': *14 '422': *15 '403': *27 @@ -93098,7 +92976,7 @@ paths: application/json: schema: type: array - items: &613 + items: &612 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -93111,7 +92989,7 @@ paths: - 1124 - -435 '202': *37 - '204': *165 + '204': *166 '422': description: Repository contains more than 10,000 commits x-github: @@ -93183,7 +93061,7 @@ paths: total: 89 week: 1336280400 '202': *37 - '204': *165 + '204': *166 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93283,7 +93161,7 @@ paths: d: 77 c: 10 '202': *37 - '204': *165 + '204': *166 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93471,7 +93349,7 @@ paths: application/json: schema: type: array - items: *613 + items: *612 examples: default: value: @@ -93484,7 +93362,7 @@ paths: - - 0 - 2 - 21 - '204': *165 + '204': *166 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93561,7 +93439,7 @@ paths: description: Response content: application/json: - schema: *614 + schema: *613 examples: default: value: @@ -93655,7 +93533,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &615 + schema: &614 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -93755,7 +93633,7 @@ paths: description: Response content: application/json: - schema: *615 + schema: *614 examples: default: value: @@ -93895,7 +93773,7 @@ paths: application/json: schema: type: array - items: &616 + items: &615 title: Tag protection description: Tag protection type: object @@ -93976,7 +93854,7 @@ paths: description: Response content: application/json: - schema: *616 + schema: *615 examples: default: value: @@ -94093,9 +93971,9 @@ paths: application/json: schema: type: array - items: *169 + items: *170 examples: - default: *221 + default: *222 headers: Link: *52 '404': *6 @@ -94124,7 +94002,7 @@ paths: description: Response content: application/json: - schema: &617 + schema: &616 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -94136,7 +94014,7 @@ paths: required: - names examples: - default: &618 + default: &617 value: names: - octocat @@ -94191,9 +94069,9 @@ paths: description: Response content: application/json: - schema: *617 + schema: *616 examples: - default: *618 + default: *617 '404': *6 '422': *7 x-github: @@ -94216,7 +94094,7 @@ paths: parameters: - *308 - *309 - - &619 + - &618 name: per description: The time frame to display results for. in: query @@ -94247,7 +94125,7 @@ paths: - 128 clones: type: array - items: &620 + items: &619 title: Traffic type: object properties: @@ -94495,7 +94373,7 @@ paths: parameters: - *308 - *309 - - *619 + - *618 responses: '200': description: Response @@ -94516,7 +94394,7 @@ paths: - 3782 views: type: array - items: *620 + items: *619 required: - uniques - count @@ -94630,7 +94508,7 @@ paths: description: Response content: application/json: - schema: *135 + schema: *136 examples: default: value: @@ -95035,9 +94913,9 @@ paths: description: Response content: application/json: - schema: *316 + schema: *314 examples: - default: *318 + default: *316 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -95078,7 +94956,7 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: default: value: @@ -95267,7 +95145,7 @@ paths: html_url: type: string format: uri - repository: *135 + repository: *136 score: type: number file_size: @@ -95286,7 +95164,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &621 + text_matches: &620 title: Search Result Text Matches type: array items: @@ -95449,7 +95327,7 @@ paths: enum: - author-date - committer-date - - &622 + - &621 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -95518,7 +95396,7 @@ paths: committer: anyOf: - type: 'null' - - *376 + - *374 comment_count: type: integer message: @@ -95537,7 +95415,7 @@ paths: url: type: string format: uri - verification: *487 + verification: *485 required: - author - committer @@ -95552,7 +95430,7 @@ paths: committer: anyOf: - type: 'null' - - *376 + - *374 parents: type: array items: @@ -95564,12 +95442,12 @@ paths: type: string sha: type: string - repository: *135 + repository: *136 score: type: number node_id: type: string - text_matches: *621 + text_matches: *620 required: - sha - node_id @@ -95761,7 +95639,7 @@ paths: - interactions - created - updated - - *622 + - *621 - *17 - *19 - name: advanced_search @@ -95858,11 +95736,11 @@ paths: type: - string - 'null' - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: type: string state_reason: @@ -95890,7 +95768,7 @@ paths: - string - 'null' format: date-time - text_matches: *621 + text_matches: *620 pull_request: type: object properties: @@ -95939,7 +95817,7 @@ paths: timeline_url: type: string format: uri - type: *205 + type: *206 performed_via_github_app: anyOf: - type: 'null' @@ -96113,7 +95991,7 @@ paths: enum: - created - updated - - *622 + - *621 - *17 - *19 responses: @@ -96158,7 +96036,7 @@ paths: - 'null' score: type: number - text_matches: *621 + text_matches: *620 required: - id - node_id @@ -96243,7 +96121,7 @@ paths: - forks - help-wanted-issues - updated - - *622 + - *621 - *17 - *19 responses: @@ -96480,7 +96358,7 @@ paths: - admin - pull - push - text_matches: *621 + text_matches: *620 temp_clone_token: type: string allow_merge_commit: @@ -96788,7 +96666,7 @@ paths: - string - 'null' format: uri - text_matches: *621 + text_matches: *620 related: type: - array @@ -96981,7 +96859,7 @@ paths: - followers - repositories - joined - - *622 + - *621 - *17 - *19 responses: @@ -97091,7 +96969,7 @@ paths: type: - boolean - 'null' - text_matches: *621 + text_matches: *620 blog: type: - string @@ -97173,7 +97051,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &626 + - &625 name: team_id description: The unique identifier of the team. in: path @@ -97214,7 +97092,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *626 + - *625 requestBody: required: true content: @@ -97315,7 +97193,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *626 + - *625 responses: '204': description: Response @@ -97346,7 +97224,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *626 + - *625 - *46 - *17 - *19 @@ -97359,7 +97237,7 @@ paths: type: array items: *295 examples: - default: *627 + default: *626 headers: Link: *52 x-github: @@ -97388,7 +97266,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *626 + - *625 requestBody: required: true content: @@ -97451,7 +97329,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *626 + - *625 - *297 responses: '200': @@ -97485,7 +97363,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *626 + - *625 - *297 requestBody: required: false @@ -97511,7 +97389,7 @@ paths: application/json: schema: *295 examples: - default: *628 + default: *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97536,7 +97414,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *626 + - *625 - *297 responses: '204': @@ -97566,7 +97444,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *626 + - *625 - *297 - *46 - *17 @@ -97580,7 +97458,7 @@ paths: type: array items: *298 examples: - default: *629 + default: *628 headers: Link: *52 x-github: @@ -97609,7 +97487,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *626 + - *625 - *297 requestBody: required: true @@ -97661,7 +97539,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *626 + - *625 - *297 - *300 responses: @@ -97696,7 +97574,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *626 + - *625 - *297 - *300 requestBody: @@ -97722,7 +97600,7 @@ paths: application/json: schema: *298 examples: - default: *630 + default: *629 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97747,7 +97625,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *626 + - *625 - *297 - *300 responses: @@ -97778,7 +97656,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *626 + - *625 - *297 - *300 - name: content @@ -97837,7 +97715,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *626 + - *625 - *297 - *300 requestBody: @@ -97899,7 +97777,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *626 + - *625 - *297 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -97957,7 +97835,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *626 + - *625 - *297 requestBody: required: true @@ -98016,7 +97894,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *626 + - *625 - *17 - *19 responses: @@ -98026,9 +97904,9 @@ paths: application/json: schema: type: array - items: *202 + items: *203 examples: - default: *203 + default: *204 headers: Link: *52 x-github: @@ -98054,7 +97932,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *626 + - *625 - name: role description: Filters members returned by their role in the team. in: query @@ -98105,7 +97983,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *626 + - *625 - *57 responses: '204': @@ -98142,7 +98020,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *626 + - *625 - *57 responses: '204': @@ -98182,7 +98060,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *626 + - *625 - *57 responses: '204': @@ -98219,7 +98097,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *626 + - *625 - *57 responses: '200': @@ -98228,7 +98106,7 @@ paths: application/json: schema: *305 examples: - response-if-user-is-a-team-maintainer: *631 + response-if-user-is-a-team-maintainer: *630 '404': *6 x-github: githubCloudOnly: false @@ -98261,7 +98139,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *626 + - *625 - *57 requestBody: required: false @@ -98289,7 +98167,7 @@ paths: application/json: schema: *305 examples: - response-if-users-membership-with-team-is-now-pending: *632 + response-if-users-membership-with-team-is-now-pending: *631 '403': description: Forbidden if team synchronization is set up '422': @@ -98323,7 +98201,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *626 + - *625 - *57 responses: '204': @@ -98352,7 +98230,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *626 + - *625 - *17 - *19 responses: @@ -98364,7 +98242,7 @@ paths: type: array items: *306 examples: - default: *633 + default: *632 headers: Link: *52 '404': *6 @@ -98390,7 +98268,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *626 + - *625 - *307 responses: '200': @@ -98399,7 +98277,7 @@ paths: application/json: schema: *306 examples: - default: *634 + default: *633 '404': description: Not Found if project is not managed by this team x-github: @@ -98423,7 +98301,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *626 + - *625 - *307 requestBody: required: false @@ -98491,7 +98369,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *626 + - *625 - *307 responses: '204': @@ -98519,7 +98397,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *626 + - *625 - *17 - *19 responses: @@ -98529,9 +98407,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: *228 + default: *229 headers: Link: *52 '404': *6 @@ -98561,7 +98439,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *626 + - *625 - *308 - *309 responses: @@ -98569,7 +98447,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *635 + schema: *634 examples: alternative-response-with-extra-repository-information: value: @@ -98720,7 +98598,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *626 + - *625 - *308 - *309 requestBody: @@ -98772,7 +98650,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *626 + - *625 - *308 - *309 responses: @@ -98799,7 +98677,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *626 + - *625 - *17 - *19 responses: @@ -98809,9 +98687,9 @@ paths: application/json: schema: type: array - items: *169 + items: *170 examples: - response-if-child-teams-exist: *636 + response-if-child-teams-exist: *635 headers: Link: *52 '404': *6 @@ -98844,7 +98722,7 @@ paths: application/json: schema: oneOf: - - &638 + - &637 title: Private User description: Private User type: object @@ -99094,7 +98972,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *637 + - *636 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -99254,7 +99132,7 @@ paths: description: Response content: application/json: - schema: *638 + schema: *637 examples: default: value: @@ -99457,9 +99335,9 @@ paths: type: integer codespaces: type: array - items: *210 + items: *211 examples: - default: *211 + default: *212 '304': *35 '500': *96 '401': *23 @@ -99598,17 +99476,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '401': *23 '403': *27 '404': *6 @@ -99652,7 +99530,7 @@ paths: type: integer secrets: type: array - items: &639 + items: &638 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -99694,7 +99572,7 @@ paths: - visibility - selected_repositories_url examples: - default: *431 + default: *429 headers: Link: *52 x-github: @@ -99766,13 +99644,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *143 + - *144 responses: '200': description: Response content: application/json: - schema: *639 + schema: *638 examples: default: value: @@ -99802,7 +99680,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *143 + - *144 requestBody: required: true content: @@ -99847,7 +99725,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -99875,7 +99753,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *143 + - *144 responses: '204': description: Response @@ -99900,7 +99778,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *143 + - *144 responses: '200': description: Response @@ -99916,9 +99794,9 @@ paths: type: integer repositories: type: array - items: *135 + items: *136 examples: - default: *640 + default: *639 '401': *23 '403': *27 '404': *6 @@ -99943,7 +99821,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *143 + - *144 requestBody: required: true content: @@ -99997,7 +99875,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *143 + - *144 - name: repository_id in: path required: true @@ -100030,7 +99908,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *143 + - *144 - name: repository_id in: path required: true @@ -100062,15 +99940,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *212 + - *213 responses: '200': description: Response content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '304': *35 '500': *96 '401': *23 @@ -100096,7 +99974,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *212 + - *213 requestBody: required: false content: @@ -100126,9 +100004,9 @@ paths: description: Response content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '401': *23 '403': *27 '404': *6 @@ -100150,7 +100028,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *212 + - *213 responses: '202': *37 '304': *35 @@ -100179,13 +100057,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *212 + - *213 responses: '202': description: Response content: application/json: - schema: &641 + schema: &640 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -100238,7 +100116,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &642 + default: &641 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -100270,7 +100148,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *212 + - *213 - name: export_id in: path required: true @@ -100283,9 +100161,9 @@ paths: description: Response content: application/json: - schema: *641 + schema: *640 examples: - default: *642 + default: *641 '404': *6 x-github: githubCloudOnly: false @@ -100306,7 +100184,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *212 + - *213 responses: '200': description: Response @@ -100322,9 +100200,9 @@ paths: type: integer machines: type: array - items: *430 + items: *428 examples: - default: *643 + default: *642 '304': *35 '500': *96 '401': *23 @@ -100353,7 +100231,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *212 + - *213 requestBody: required: true content: @@ -100409,11 +100287,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *316 + repository: *314 machine: anyOf: - type: 'null' - - *430 + - *428 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -101210,15 +101088,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *212 + - *213 responses: '200': description: Response content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '304': *35 '500': *96 '400': *14 @@ -101250,15 +101128,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *212 + - *213 responses: '200': description: Response content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '500': *96 '401': *23 '403': *27 @@ -101288,9 +101166,9 @@ paths: application/json: schema: type: array - items: *222 + items: *223 examples: - default: &654 + default: &653 value: - id: 197 name: hello_docker @@ -101391,7 +101269,7 @@ paths: application/json: schema: type: array - items: &644 + items: &643 title: Email description: Email type: object @@ -101461,9 +101339,9 @@ paths: application/json: schema: type: array - items: *644 + items: *643 examples: - default: &656 + default: &655 value: - email: octocat@github.com verified: true @@ -101540,7 +101418,7 @@ paths: application/json: schema: type: array - items: *644 + items: *643 examples: default: value: @@ -101798,7 +101676,7 @@ paths: application/json: schema: type: array - items: &645 + items: &644 title: GPG Key description: A unique encryption key type: object @@ -101943,7 +101821,7 @@ paths: - subkeys - revoked examples: - default: &670 + default: &669 value: - id: 3 name: Octocat's GPG Key @@ -102028,9 +101906,9 @@ paths: description: Response content: application/json: - schema: *645 + schema: *644 examples: - default: &646 + default: &645 value: id: 3 name: Octocat's GPG Key @@ -102087,7 +101965,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &647 + - &646 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -102099,9 +101977,9 @@ paths: description: Response content: application/json: - schema: *645 + schema: *644 examples: - default: *646 + default: *645 '404': *6 '304': *35 '403': *27 @@ -102124,7 +102002,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *647 + - *646 responses: '204': description: Response @@ -102315,7 +102193,7 @@ paths: type: array items: *64 examples: - default: *127 + default: *128 headers: Link: *52 '404': *6 @@ -102340,7 +102218,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *124 + - *125 responses: '204': description: Response @@ -102366,7 +102244,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *124 + - *125 responses: '204': description: Response @@ -102400,12 +102278,12 @@ paths: application/json: schema: anyOf: - - *200 + - *201 - type: object properties: {} additionalProperties: false examples: - default: *201 + default: *202 '204': description: Response when there are no restrictions x-github: @@ -102429,7 +102307,7 @@ paths: required: true content: application/json: - schema: *498 + schema: *496 examples: default: value: @@ -102440,7 +102318,7 @@ paths: description: Response content: application/json: - schema: *200 + schema: *201 examples: default: value: @@ -102521,7 +102399,7 @@ paths: - closed - all default: open - - *208 + - *209 - name: sort description: What to sort results by. in: query @@ -102546,7 +102424,7 @@ paths: type: array items: *78 examples: - default: *209 + default: *210 headers: Link: *52 '404': *6 @@ -102579,7 +102457,7 @@ paths: application/json: schema: type: array - items: &648 + items: &647 title: Key description: Key type: object @@ -102682,9 +102560,9 @@ paths: description: Response content: application/json: - schema: *648 + schema: *647 examples: - default: &649 + default: &648 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -102717,15 +102595,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *525 + - *524 responses: '200': description: Response content: application/json: - schema: *648 + schema: *647 examples: - default: *649 + default: *648 '404': *6 '304': *35 '403': *27 @@ -102748,7 +102626,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *525 + - *524 responses: '204': description: Response @@ -102781,7 +102659,7 @@ paths: application/json: schema: type: array - items: &650 + items: &649 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -102860,7 +102738,7 @@ paths: - account - plan examples: - default: &651 + default: &650 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -102922,9 +102800,9 @@ paths: application/json: schema: type: array - items: *650 + items: *649 examples: - default: *651 + default: *650 headers: Link: *52 '304': *35 @@ -102964,7 +102842,7 @@ paths: application/json: schema: type: array - items: *214 + items: *215 examples: default: value: @@ -103072,7 +102950,7 @@ paths: description: Response content: application/json: - schema: *214 + schema: *215 examples: default: value: @@ -103155,7 +103033,7 @@ paths: description: Response content: application/json: - schema: *214 + schema: *215 examples: default: value: @@ -103223,7 +103101,7 @@ paths: application/json: schema: type: array - items: *216 + items: *217 examples: default: value: @@ -103485,7 +103363,7 @@ paths: description: Response content: application/json: - schema: *216 + schema: *217 examples: default: value: @@ -103665,7 +103543,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *217 + - *218 - name: exclude in: query required: false @@ -103678,7 +103556,7 @@ paths: description: Response content: application/json: - schema: *216 + schema: *217 examples: default: value: @@ -103872,7 +103750,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *217 + - *218 responses: '302': description: Response @@ -103898,7 +103776,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *217 + - *218 responses: '204': description: Response @@ -103927,8 +103805,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *217 - - *652 + - *218 + - *651 responses: '204': description: Response @@ -103952,7 +103830,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *217 + - *218 - *17 - *19 responses: @@ -103962,9 +103840,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: *228 + default: *229 headers: Link: *52 '404': *6 @@ -104043,7 +103921,7 @@ paths: - docker - nuget - container - - *653 + - *652 - *19 - *17 responses: @@ -104053,10 +103931,10 @@ paths: application/json: schema: type: array - items: *222 + items: *223 examples: - default: *654 - '400': *655 + default: *653 + '400': *654 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104076,16 +103954,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *224 - *225 + - *226 responses: '200': description: Response content: application/json: - schema: *222 + schema: *223 examples: - default: &671 + default: &670 value: id: 40201 name: octo-name @@ -104198,8 +104076,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *224 - *225 + - *226 responses: '204': description: Response @@ -104229,8 +104107,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *224 - *225 + - *226 - name: token description: package token schema: @@ -104262,8 +104140,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: - - *224 - *225 + - *226 - *19 - *17 - name: state @@ -104283,7 +104161,7 @@ paths: application/json: schema: type: array - items: *226 + items: *227 examples: default: value: @@ -104332,15 +104210,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *224 - *225 - - *227 + - *226 + - *228 responses: '200': description: Response content: application/json: - schema: *226 + schema: *227 examples: default: value: @@ -104376,9 +104254,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *224 - *225 - - *227 + - *226 + - *228 responses: '204': description: Response @@ -104408,9 +104286,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *224 - *225 - - *227 + - *226 + - *228 responses: '204': description: Response @@ -104422,99 +104300,6 @@ paths: enabledForGitHubApps: false category: packages subcategory: packages - "/user/projects": - post: - summary: Create a user 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: - - projects-classic - operationId: projects-classic/create-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#create-a-user-project - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - required: - - name - type: object - examples: - default: - summary: Create a new project - value: - name: My Projects - body: A board to manage my personal projects. - responses: - '201': - description: Response - content: - application/json: - schema: *238 - examples: - default: - value: - owner_url: https://api.github.com/users/octocat - url: https://api.github.com/projects/1002603 - html_url: https://github.com/users/octocat/projects/1 - columns_url: https://api.github.com/projects/1002603/columns - id: 1002603 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - name: My Projects - body: A board to manage my personal projects. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - '304': *35 - '403': *27 - '401': *23 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/user/public_emails": get: summary: List public email addresses for the authenticated user @@ -104540,9 +104325,9 @@ paths: application/json: schema: type: array - items: *644 + items: *643 examples: - default: *656 + default: *655 headers: Link: *52 '304': *35 @@ -104655,7 +104440,7 @@ paths: type: array items: *64 examples: - default: &663 + default: &662 summary: Default response value: - id: 1296269 @@ -104973,9 +104758,9 @@ paths: description: Response content: application/json: - schema: *316 + schema: *314 examples: - default: *318 + default: *316 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -105013,9 +104798,9 @@ paths: application/json: schema: type: array - items: *500 + items: *498 examples: - default: *657 + default: *656 headers: Link: *52 '304': *35 @@ -105038,7 +104823,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *204 + - *205 responses: '204': description: Response @@ -105061,7 +104846,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *204 + - *205 responses: '204': description: Response @@ -105094,7 +104879,7 @@ paths: application/json: schema: type: array - items: &658 + items: &657 title: Social account description: Social media account type: object @@ -105111,7 +104896,7 @@ paths: - provider - url examples: - default: &659 + default: &658 value: - provider: twitter url: https://twitter.com/github @@ -105174,9 +104959,9 @@ paths: application/json: schema: type: array - items: *658 + items: *657 examples: - default: *659 + default: *658 '422': *15 '304': *35 '404': *6 @@ -105264,7 +105049,7 @@ paths: application/json: schema: type: array - items: &660 + items: &659 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -105284,7 +105069,7 @@ paths: - title - created_at examples: - default: &686 + default: &685 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -105351,9 +105136,9 @@ paths: description: Response content: application/json: - schema: *660 + schema: *659 examples: - default: &661 + default: &660 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -105384,7 +105169,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: - - &662 + - &661 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -105396,9 +105181,9 @@ paths: description: Response content: application/json: - schema: *660 + schema: *659 examples: - default: *661 + default: *660 '404': *6 '304': *35 '403': *27 @@ -105421,7 +105206,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: - - *662 + - *661 responses: '204': description: Response @@ -105450,7 +105235,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &687 + - &686 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 @@ -105475,11 +105260,11 @@ paths: type: array items: *64 examples: - default-response: *663 + default-response: *662 application/vnd.github.v3.star+json: schema: type: array - items: &688 + items: &687 title: Starred Repository description: Starred Repository type: object @@ -105723,9 +105508,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: *228 + default: *229 headers: Link: *52 '304': *35 @@ -105848,10 +105633,10 @@ paths: application/json: schema: oneOf: - - *638 - *637 + - *636 examples: - default-response: &665 + default-response: &664 summary: Default response value: login: octocat @@ -105886,7 +105671,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &666 + response-with-git-hub-plan-information: &665 summary: Response with GitHub plan information value: login: octocat @@ -105946,7 +105731,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *664 + - *663 - *17 responses: '200': @@ -105995,11 +105780,11 @@ paths: application/json: schema: oneOf: - - *638 - *637 + - *636 examples: - default-response: *665 - response-with-git-hub-plan-information: *666 + default-response: *664 + response-with-git-hub-plan-information: *665 '404': *6 x-github: githubCloudOnly: false @@ -106049,8 +105834,8 @@ paths: required: - subject_digests examples: - default: *667 - withPredicateType: *668 + default: *666 + withPredicateType: *667 responses: '200': description: Response @@ -106104,7 +105889,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *669 + default: *668 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106309,12 +106094,12 @@ paths: initiator: type: string examples: - default: *372 + default: *370 '201': description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -106348,9 +106133,9 @@ paths: application/json: schema: type: array - items: *222 + items: *223 examples: - default: *654 + default: *653 '403': *27 '401': *23 x-github: @@ -106734,9 +106519,9 @@ paths: application/json: schema: type: array - items: *645 + items: *644 examples: - default: *670 + default: *669 headers: Link: *52 x-github: @@ -106840,7 +106625,7 @@ paths: application/json: schema: *20 examples: - default: *497 + default: *495 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106965,7 +106750,7 @@ paths: - docker - nuget - container - - *653 + - *652 - *57 - *19 - *17 @@ -106976,12 +106761,12 @@ paths: application/json: schema: type: array - items: *222 + items: *223 examples: - default: *654 + default: *653 '403': *27 '401': *23 - '400': *655 + '400': *654 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107001,17 +106786,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *224 - *225 + - *226 - *57 responses: '200': description: Response content: application/json: - schema: *222 + schema: *223 examples: - default: *671 + default: *670 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107032,8 +106817,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *224 - *225 + - *226 - *57 responses: '204': @@ -107066,8 +106851,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *224 - *225 + - *226 - *57 - name: token description: package token @@ -107100,8 +106885,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *224 - *225 + - *226 - *57 responses: '200': @@ -107110,7 +106895,7 @@ paths: application/json: schema: type: array - items: *226 + items: *227 examples: default: value: @@ -107168,16 +106953,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *224 - *225 - - *227 + - *226 + - *228 - *57 responses: '200': description: Response content: application/json: - schema: *226 + schema: *227 examples: default: value: @@ -107212,10 +106997,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *224 - *225 + - *226 - *57 - - *227 + - *228 responses: '204': description: Response @@ -107247,10 +107032,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *224 - *225 + - *226 - *57 - - *227 + - *228 responses: '204': description: Response @@ -107262,87 +107047,6 @@ paths: enabledForGitHubApps: false category: packages subcategory: packages - "/users/{username}/projects": - get: - summary: List user 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: - - projects-classic - operationId: projects-classic/list-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#list-user-projects - parameters: - - *57 - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *238 - examples: - default: - value: - - owner_url: https://api.github.com/users/octocat - url: https://api.github.com/projects/1002603 - html_url: https://github.com/users/octocat/projects/1 - columns_url: https://api.github.com/projects/1002603/columns - id: 1002603 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - name: My Projects - body: A board to manage my personal projects. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - headers: - Link: *52 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/users/{username}/projectsV2": get: summary: List projects for user @@ -107441,7 +107145,7 @@ paths: type: array items: *242 examples: - default: *672 + default: *671 headers: Link: *52 '304': *35 @@ -107464,7 +107168,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *241 - - *673 + - *672 - *57 responses: '200': @@ -107473,7 +107177,7 @@ paths: application/json: schema: *242 examples: - default: *674 + default: *673 headers: Link: *52 '304': *35 @@ -107590,7 +107294,7 @@ paths: description: Response content: application/json: - schema: *675 + schema: *674 examples: issue: *246 pull_request: *246 @@ -107979,9 +107683,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: *228 + default: *229 headers: Link: *52 x-github: @@ -108011,9 +107715,9 @@ paths: description: Response content: application/json: - schema: *676 + schema: *675 examples: - default: *677 + default: *676 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108041,9 +107745,9 @@ paths: description: Response content: application/json: - schema: *678 + schema: *677 examples: - default: *679 + default: *678 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108064,11 +107768,11 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-a-user parameters: - *57 - - *98 - - *100 - *99 - - *680 - *101 + - *100 + - *679 + - *102 responses: '200': description: Response when getting a billing premium request usage report @@ -108204,9 +107908,9 @@ paths: description: Response content: application/json: - schema: *681 + schema: *680 examples: - default: *682 + default: *681 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108227,9 +107931,9 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - *57 - - *98 - - *683 - *99 + - *682 + - *100 responses: '200': description: Response when getting a billing usage report @@ -108308,7 +108012,7 @@ paths: subcategory: enhanced-billing "/users/{username}/settings/billing/usage/summary": get: - summary: Get billing usage summary report for a user + summary: Get billing usage summary for a user description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. @@ -108321,18 +108025,18 @@ paths: operationId: billing/get-github-billing-usage-summary-report-user externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-report-for-a-user + url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-for-a-user parameters: - *57 - - *98 - - *100 - *99 - - *684 - *101 - - *685 + - *100 + - *683 + - *102 + - *684 responses: '200': - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -108463,9 +108167,9 @@ paths: application/json: schema: type: array - items: *658 + items: *657 examples: - default: *659 + default: *658 headers: Link: *52 x-github: @@ -108495,9 +108199,9 @@ paths: application/json: schema: type: array - items: *660 + items: *659 examples: - default: *686 + default: *685 headers: Link: *52 x-github: @@ -108522,7 +108226,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *57 - - *687 + - *686 - *46 - *17 - *19 @@ -108534,11 +108238,11 @@ paths: schema: anyOf: - type: array - items: *688 + items: *687 - type: array items: *64 examples: - default-response: *663 + default-response: *662 headers: Link: *52 x-github: @@ -108567,9 +108271,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: *228 + default: *229 headers: Link: *52 x-github: @@ -108698,7 +108402,7 @@ webhooks: type: string enum: - disabled - enterprise: &689 + enterprise: &688 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -108767,7 +108471,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &690 + installation: &689 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -108788,7 +108492,7 @@ webhooks: required: - id - node_id - organization: &691 + organization: &690 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -108861,7 +108565,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &692 + repository: &691 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -109774,10 +109478,10 @@ webhooks: type: string enum: - enabled - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -109853,11 +109557,11 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 - rule: &693 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 + rule: &692 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) @@ -110080,11 +109784,11 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 - rule: *693 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 + rule: *692 sender: *4 required: - action @@ -110272,11 +109976,11 @@ webhooks: - everyone required: - from - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 - rule: *693 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 + rule: *692 sender: *4 required: - action @@ -110360,7 +110064,7 @@ webhooks: type: string enum: - completed - check_run: &695 + check_run: &694 title: CheckRun description: A check performed on the code of a given code change type: object @@ -110425,8 +110129,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *389 - repository: *135 + items: *387 + repository: *136 status: type: string enum: @@ -110470,7 +110174,7 @@ webhooks: - examples: - neutral - deployment: *694 + deployment: *693 details_url: type: string examples: @@ -110530,7 +110234,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *389 + items: *387 started_at: type: string format: date-time @@ -110568,10 +110272,10 @@ webhooks: - output - app - pull_requests - installation: *690 - enterprise: *689 - organization: *691 - repository: *692 + installation: *689 + enterprise: *688 + organization: *690 + repository: *691 sender: *4 required: - check_run @@ -110964,11 +110668,11 @@ webhooks: type: string enum: - created - check_run: *695 - installation: *690 - enterprise: *689 - organization: *691 - repository: *692 + check_run: *694 + installation: *689 + enterprise: *688 + organization: *690 + repository: *691 sender: *4 required: - check_run @@ -111364,11 +111068,11 @@ webhooks: type: string enum: - requested_action - check_run: *695 - installation: *690 - enterprise: *689 - organization: *691 - repository: *692 + check_run: *694 + installation: *689 + enterprise: *688 + organization: *690 + repository: *691 requested_action: description: The action requested by the user. type: object @@ -111773,11 +111477,11 @@ webhooks: type: string enum: - rerequested - check_run: *695 - installation: *690 - enterprise: *689 - organization: *691 - repository: *692 + check_run: *694 + installation: *689 + enterprise: *688 + organization: *690 + repository: *691 sender: *4 required: - check_run @@ -112769,10 +112473,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -113457,10 +113161,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -114139,10 +113843,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -114311,7 +114015,7 @@ webhooks: required: - login - id - dismissed_comment: *404 + dismissed_comment: *402 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -114463,20 +114167,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &696 + commit_oid: &695 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: *689 - installation: *690 - organization: *691 - ref: &697 + enterprise: *688 + installation: *689 + organization: *690 + ref: &696 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: *692 + repository: *691 sender: *4 required: - action @@ -114643,7 +114347,7 @@ webhooks: required: - login - id - dismissed_comment: *404 + dismissed_comment: *402 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -114884,12 +114588,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *696 - enterprise: *689 - installation: *690 - organization: *691 - ref: *697 - repository: *692 + commit_oid: *695 + enterprise: *688 + installation: *689 + organization: *690 + ref: *696 + repository: *691 sender: *4 required: - action @@ -114987,7 +114691,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *404 + dismissed_comment: *402 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -115172,12 +114876,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *696 - enterprise: *689 - installation: *690 - organization: *691 - ref: *697 - repository: *692 + commit_oid: *695 + enterprise: *688 + installation: *689 + organization: *690 + ref: *696 + repository: *691 sender: *4 required: - action @@ -115346,7 +115050,7 @@ webhooks: required: - login - id - dismissed_comment: *404 + dismissed_comment: *402 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -115523,12 +115227,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *696 - enterprise: *689 - installation: *690 - organization: *691 - ref: *697 - repository: *692 + commit_oid: *695 + enterprise: *688 + installation: *689 + organization: *690 + ref: *696 + repository: *691 sender: *4 required: - action @@ -115631,7 +115335,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *404 + dismissed_comment: *402 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -115811,9 +115515,9 @@ webhooks: type: - string - 'null' - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -115821,7 +115525,7 @@ webhooks: type: - string - 'null' - repository: *692 + repository: *691 sender: *4 required: - action @@ -115920,7 +115624,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *404 + dismissed_comment: *402 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -116067,12 +115771,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *696 - enterprise: *689 - installation: *690 - organization: *691 - ref: *697 - repository: *692 + commit_oid: *695 + enterprise: *688 + installation: *689 + organization: *690 + ref: *696 + repository: *691 sender: *4 required: - action @@ -116334,10 +116038,10 @@ webhooks: - updated_at - author_association - body - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -116418,18 +116122,18 @@ webhooks: type: - string - 'null' - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *691 - pusher_type: &698 + organization: *690 + pusher_type: &697 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &699 + ref: &698 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -116439,7 +116143,7 @@ webhooks: enum: - tag - branch - repository: *692 + repository: *691 sender: *4 required: - ref @@ -116522,9 +116226,9 @@ webhooks: enum: - created definition: *250 - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 sender: *4 required: - action @@ -116609,9 +116313,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 sender: *4 required: - action @@ -116689,9 +116393,9 @@ webhooks: enum: - promote_to_enterprise definition: *250 - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 sender: *4 required: - action @@ -116769,9 +116473,9 @@ webhooks: enum: - updated definition: *250 - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 sender: *4 required: - action @@ -116848,10 +116552,10 @@ webhooks: type: string enum: - updated - enterprise: *689 - installation: *690 - repository: *692 - organization: *691 + enterprise: *688 + installation: *689 + repository: *691 + organization: *690 sender: *4 new_property_values: type: array @@ -116936,18 +116640,18 @@ webhooks: title: delete event type: object properties: - enterprise: *689 - installation: *690 - organization: *691 - pusher_type: *698 - ref: *699 + enterprise: *688 + installation: *689 + organization: *690 + pusher_type: *697 + ref: *698 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *692 + repository: *691 sender: *4 required: - ref @@ -117031,11 +116735,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *456 - installation: *690 - organization: *691 - enterprise: *689 - repository: *692 + alert: *454 + installation: *689 + organization: *690 + enterprise: *688 + repository: *691 sender: *4 required: - action @@ -117119,11 +116823,11 @@ webhooks: type: string enum: - auto_reopened - alert: *456 - installation: *690 - organization: *691 - enterprise: *689 - repository: *692 + alert: *454 + installation: *689 + organization: *690 + enterprise: *688 + repository: *691 sender: *4 required: - action @@ -117207,11 +116911,11 @@ webhooks: type: string enum: - created - alert: *456 - installation: *690 - organization: *691 - enterprise: *689 - repository: *692 + alert: *454 + installation: *689 + organization: *690 + enterprise: *688 + repository: *691 sender: *4 required: - action @@ -117293,11 +116997,11 @@ webhooks: type: string enum: - dismissed - alert: *456 - installation: *690 - organization: *691 - enterprise: *689 - repository: *692 + alert: *454 + installation: *689 + organization: *690 + enterprise: *688 + repository: *691 sender: *4 required: - action @@ -117379,11 +117083,11 @@ webhooks: type: string enum: - fixed - alert: *456 - installation: *690 - organization: *691 - enterprise: *689 - repository: *692 + alert: *454 + installation: *689 + organization: *690 + enterprise: *688 + repository: *691 sender: *4 required: - action @@ -117466,11 +117170,11 @@ webhooks: type: string enum: - reintroduced - alert: *456 - installation: *690 - organization: *691 - enterprise: *689 - repository: *692 + alert: *454 + installation: *689 + organization: *690 + enterprise: *688 + repository: *691 sender: *4 required: - action @@ -117552,11 +117256,11 @@ webhooks: type: string enum: - reopened - alert: *456 - installation: *690 - organization: *691 - enterprise: *689 - repository: *692 + alert: *454 + installation: *689 + organization: *690 + enterprise: *688 + repository: *691 sender: *4 required: - action @@ -117633,9 +117337,9 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - key: &700 + enterprise: *688 + installation: *689 + key: &699 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -117673,8 +117377,8 @@ webhooks: - verified - created_at - read_only - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -117751,11 +117455,11 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - key: *700 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + key: *699 + organization: *690 + repository: *691 sender: *4 required: - action @@ -118327,12 +118031,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - workflow: &704 + workflow: &703 title: Workflow type: - object @@ -119070,13 +118774,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *462 + deployment: *460 pull_requests: type: array - items: *545 - repository: *692 - organization: *691 - installation: *690 + items: *544 + repository: *691 + organization: *690 + installation: *689 sender: *4 responses: '200': @@ -119147,7 +118851,7 @@ webhooks: type: string enum: - approved - approver: &701 + approver: &700 type: object properties: avatar_url: @@ -119190,11 +118894,11 @@ webhooks: type: string comment: type: string - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 - reviewers: &702 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 + reviewers: &701 type: array items: type: object @@ -119275,7 +118979,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &703 + workflow_job_run: &702 type: object properties: conclusion: @@ -120021,18 +119725,18 @@ webhooks: type: string enum: - rejected - approver: *701 + approver: *700 comment: type: string - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 - reviewers: *702 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 + reviewers: *701 sender: *4 since: type: string - workflow_job_run: *703 + workflow_job_run: *702 workflow_job_runs: type: array items: @@ -120749,13 +120453,13 @@ webhooks: type: string enum: - requested - enterprise: *689 + enterprise: *688 environment: type: string - installation: *690 - organization: *691 - repository: *692 - requestor: &709 + installation: *689 + organization: *690 + repository: *691 + requestor: &708 title: User type: - object @@ -122698,12 +122402,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - workflow: *704 + workflow: *703 workflow_run: title: Deployment Workflow Run type: @@ -123394,7 +123098,7 @@ webhooks: type: string enum: - answered - answer: &707 + answer: &706 type: object properties: author_association: @@ -123554,7 +123258,7 @@ webhooks: - created_at - updated_at - body - discussion: &705 + discussion: &704 title: Discussion description: A Discussion in a repository. type: object @@ -123850,7 +123554,7 @@ webhooks: - id labels: type: array - items: *508 + items: *507 required: - repository_url - category @@ -123872,10 +123576,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -124002,11 +123706,11 @@ webhooks: - from required: - category - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -124089,11 +123793,11 @@ webhooks: type: string enum: - closed - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -124175,7 +123879,7 @@ webhooks: type: string enum: - created - comment: &706 + comment: &705 type: object properties: author_association: @@ -124335,11 +124039,11 @@ webhooks: - updated_at - body - reactions - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -124422,12 +124126,12 @@ webhooks: type: string enum: - deleted - comment: *706 - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + comment: *705 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -124522,12 +124226,12 @@ webhooks: - from required: - body - comment: *706 - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + comment: *705 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -124611,11 +124315,11 @@ webhooks: type: string enum: - created - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -124697,11 +124401,11 @@ webhooks: type: string enum: - deleted - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -124801,11 +124505,11 @@ webhooks: type: string required: - from - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -124887,10 +124591,10 @@ webhooks: type: string enum: - labeled - discussion: *705 - enterprise: *689 - installation: *690 - label: &708 + discussion: *704 + enterprise: *688 + installation: *689 + label: &707 title: Label type: object properties: @@ -124923,8 +124627,8 @@ webhooks: - color - default - description - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -125007,11 +124711,11 @@ webhooks: type: string enum: - locked - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -125093,11 +124797,11 @@ webhooks: type: string enum: - pinned - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -125179,11 +124883,11 @@ webhooks: type: string enum: - reopened - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -125268,16 +124972,16 @@ webhooks: changes: type: object properties: - new_discussion: *705 - new_repository: *692 + new_discussion: *704 + new_repository: *691 required: - new_discussion - new_repository - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -125360,10 +125064,10 @@ webhooks: type: string enum: - unanswered - discussion: *705 - old_answer: *707 - organization: *691 - repository: *692 + discussion: *704 + old_answer: *706 + organization: *690 + repository: *691 sender: *4 required: - action @@ -125445,12 +125149,12 @@ webhooks: type: string enum: - unlabeled - discussion: *705 - enterprise: *689 - installation: *690 - label: *708 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + label: *707 + organization: *690 + repository: *691 sender: *4 required: - action @@ -125533,11 +125237,11 @@ webhooks: type: string enum: - unlocked - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -125619,11 +125323,11 @@ webhooks: type: string enum: - unpinned - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -125696,7 +125400,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *689 + enterprise: *688 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -126374,9 +126078,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - forkee @@ -126522,9 +126226,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 pages: description: The pages that were updated. type: array @@ -126562,7 +126266,7 @@ webhooks: - action - sha - html_url - repository: *692 + repository: *691 sender: *4 required: - pages @@ -126638,10 +126342,10 @@ webhooks: type: string enum: - created - enterprise: *689 + enterprise: *688 installation: *20 - organization: *691 - repositories: &710 + organization: *690 + repositories: &709 description: An array of repository objects that the installation can access. type: array @@ -126667,8 +126371,8 @@ webhooks: - name - full_name - private - repository: *692 - requester: *709 + repository: *691 + requester: *708 sender: *4 required: - action @@ -126743,11 +126447,11 @@ webhooks: type: string enum: - deleted - enterprise: *689 + enterprise: *688 installation: *20 - organization: *691 - repositories: *710 - repository: *692 + organization: *690 + repositories: *709 + repository: *691 requester: type: - 'null' @@ -126824,11 +126528,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *689 + enterprise: *688 installation: *20 - organization: *691 - repositories: *710 - repository: *692 + organization: *690 + repositories: *709 + repository: *691 requester: type: - 'null' @@ -126905,10 +126609,10 @@ webhooks: type: string enum: - added - enterprise: *689 + enterprise: *688 installation: *20 - organization: *691 - repositories_added: &711 + organization: *690 + repositories_added: &710 description: An array of repository objects, which were added to the installation. type: array @@ -126954,15 +126658,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *692 - repository_selection: &712 + repository: *691 + repository_selection: &711 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *709 + requester: *708 sender: *4 required: - action @@ -127041,10 +126745,10 @@ webhooks: type: string enum: - removed - enterprise: *689 + enterprise: *688 installation: *20 - organization: *691 - repositories_added: *711 + organization: *690 + repositories_added: *710 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -127071,9 +126775,9 @@ webhooks: - name - full_name - private - repository: *692 - repository_selection: *712 - requester: *709 + repository: *691 + repository_selection: *711 + requester: *708 sender: *4 required: - action @@ -127152,11 +126856,11 @@ webhooks: type: string enum: - suspend - enterprise: *689 + enterprise: *688 installation: *20 - organization: *691 - repositories: *710 - repository: *692 + organization: *690 + repositories: *709 + repository: *691 requester: type: - 'null' @@ -127338,10 +127042,10 @@ webhooks: type: string required: - from - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 target_type: type: string @@ -127420,11 +127124,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *689 + enterprise: *688 installation: *20 - organization: *691 - repositories: *710 - repository: *692 + organization: *690 + repositories: *709 + repository: *691 requester: type: - 'null' @@ -127672,8 +127376,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128490,8 +128194,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128508,7 +128212,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -128852,8 +128556,8 @@ webhooks: - state - locked - assignee - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -128933,7 +128637,7 @@ webhooks: type: string enum: - deleted - comment: &713 + comment: &712 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -129100,8 +128804,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -129914,8 +129618,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 state: description: State of the issue; either 'open' or 'closed' type: string @@ -129932,7 +129636,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -130278,8 +129982,8 @@ webhooks: - state - locked - assignee - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -130359,7 +130063,7 @@ webhooks: type: string enum: - edited - changes: &737 + changes: &736 description: The changes to the comment. type: object properties: @@ -130371,9 +130075,9 @@ webhooks: type: string required: - from - comment: *713 - enterprise: *689 - installation: *690 + comment: *712 + enterprise: *688 + installation: *689 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -131189,8 +130893,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131207,7 +130911,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -131551,8 +131255,8 @@ webhooks: - state - locked - assignee - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -131642,9 +131346,9 @@ webhooks: type: number blocking_issue: *78 blocking_issue_repo: *64 - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -131738,9 +131442,9 @@ webhooks: type: number blocking_issue: *78 blocking_issue_repo: *64 - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -131833,9 +131537,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *78 - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -131929,9 +131633,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *78 - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -132016,10 +131720,10 @@ webhooks: type: string enum: - assigned - assignee: *709 - enterprise: *689 - installation: *690 - issue: &716 + assignee: *708 + enterprise: *688 + installation: *689 + issue: &715 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -132831,11 +132535,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132852,7 +132556,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -132955,8 +132659,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -133036,8 +132740,8 @@ webhooks: type: string enum: - closed - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -133854,11 +133558,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133875,7 +133579,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -134121,8 +133825,8 @@ webhooks: required: - state - closed_at - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -134201,8 +133905,8 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135010,11 +134714,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135031,7 +134735,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -135133,8 +134837,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -135213,8 +134917,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136045,11 +135749,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136066,7 +135770,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -136147,7 +135851,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &714 + milestone: &713 title: Milestone description: A collection of related issues and pull requests. type: object @@ -136290,8 +135994,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -136390,8 +136094,8 @@ webhooks: type: string required: - from - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137203,11 +136907,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137221,7 +136925,7 @@ webhooks: timeline_url: type: string format: uri - type: *205 + type: *206 title: description: Title of the issue type: string @@ -137327,9 +137031,9 @@ webhooks: - active_lock_reason - body - reactions - label: *708 - organization: *691 - repository: *692 + label: *707 + organization: *690 + repository: *691 sender: *4 required: - action @@ -137409,8 +137113,8 @@ webhooks: type: string enum: - labeled - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -138221,11 +137925,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138239,7 +137943,7 @@ webhooks: timeline_url: type: string format: uri - type: *205 + type: *206 title: description: Title of the issue type: string @@ -138345,9 +138049,9 @@ webhooks: - active_lock_reason - body - reactions - label: *708 - organization: *691 - repository: *692 + label: *707 + organization: *690 + repository: *691 sender: *4 required: - action @@ -138427,8 +138131,8 @@ webhooks: type: string enum: - locked - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139264,11 +138968,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139282,7 +138986,7 @@ webhooks: timeline_url: type: string format: uri - type: *205 + type: *206 title: description: Title of the issue type: string @@ -139365,8 +139069,8 @@ webhooks: format: uri user_view_type: type: string - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -139445,8 +139149,8 @@ webhooks: type: string enum: - milestoned - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -140276,11 +139980,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140297,7 +140001,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -140377,9 +140081,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *714 - organization: *691 - repository: *692 + milestone: *713 + organization: *690 + repository: *691 sender: *4 required: - action @@ -141271,11 +140975,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141371,7 +141075,7 @@ webhooks: required: - login - id - type: *205 + type: *206 required: - id - number @@ -141852,8 +141556,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142665,11 +142369,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142686,7 +142390,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -142788,8 +142492,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -142869,9 +142573,9 @@ webhooks: type: string enum: - pinned - enterprise: *689 - installation: *690 - issue: &715 + enterprise: *688 + installation: *689 + issue: &714 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -143677,11 +143381,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143698,7 +143402,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -143800,8 +143504,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -143880,8 +143584,8 @@ webhooks: type: string enum: - reopened - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144715,11 +144419,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144816,9 +144520,9 @@ webhooks: format: uri user_view_type: type: string - type: *205 - organization: *691 - repository: *692 + type: *206 + organization: *690 + repository: *691 sender: *4 required: - action @@ -145707,11 +145411,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145728,7 +145432,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -146310,11 +146014,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *689 - installation: *690 - issue: *715 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + issue: *714 + organization: *690 + repository: *691 sender: *4 required: - action @@ -146394,12 +146098,12 @@ webhooks: type: string enum: - typed - enterprise: *689 - installation: *690 - issue: *716 - type: *205 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + issue: *715 + type: *206 + organization: *690 + repository: *691 sender: *4 required: - action @@ -146480,7 +146184,7 @@ webhooks: type: string enum: - unassigned - assignee: &740 + assignee: &739 title: User type: - object @@ -146552,11 +146256,11 @@ webhooks: required: - login - id - enterprise: *689 - installation: *690 - issue: *716 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + issue: *715 + organization: *690 + repository: *691 sender: *4 required: - action @@ -146635,12 +146339,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *689 - installation: *690 - issue: *716 - label: *708 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + issue: *715 + label: *707 + organization: *690 + repository: *691 sender: *4 required: - action @@ -146720,8 +146424,8 @@ webhooks: type: string enum: - unlocked - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147555,11 +147259,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147576,7 +147280,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -147656,8 +147360,8 @@ webhooks: format: uri user_view_type: type: string - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -147737,11 +147441,11 @@ webhooks: type: string enum: - unpinned - enterprise: *689 - installation: *690 - issue: *715 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + issue: *714 + organization: *690 + repository: *691 sender: *4 required: - action @@ -147820,12 +147524,12 @@ webhooks: type: string enum: - untyped - enterprise: *689 - installation: *690 - issue: *716 - type: *205 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + issue: *715 + type: *206 + organization: *690 + repository: *691 sender: *4 required: - action @@ -147905,11 +147609,11 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - label: *708 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + label: *707 + organization: *690 + repository: *691 sender: *4 required: - action @@ -147987,11 +147691,11 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - label: *708 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + label: *707 + organization: *690 + repository: *691 sender: *4 required: - action @@ -148101,11 +147805,11 @@ webhooks: type: string required: - from - enterprise: *689 - installation: *690 - label: *708 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + label: *707 + organization: *690 + repository: *691 sender: *4 required: - action @@ -148187,9 +147891,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *689 - installation: *690 - marketplace_purchase: &717 + enterprise: *688 + installation: *689 + marketplace_purchase: &716 title: Marketplace Purchase type: object required: @@ -148277,8 +147981,8 @@ webhooks: type: integer unit_count: type: integer - organization: *691 - previous_marketplace_purchase: &718 + organization: *690 + previous_marketplace_purchase: &717 title: Marketplace Purchase type: object properties: @@ -148362,7 +148066,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *692 + repository: *691 sender: *4 required: - action @@ -148442,10 +148146,10 @@ webhooks: - changed effective_date: type: string - enterprise: *689 - installation: *690 - marketplace_purchase: *717 - organization: *691 + enterprise: *688 + installation: *689 + marketplace_purchase: *716 + organization: *690 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -148533,7 +148237,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *692 + repository: *691 sender: *4 required: - action @@ -148615,10 +148319,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *689 - installation: *690 - marketplace_purchase: *717 - organization: *691 + enterprise: *688 + installation: *689 + marketplace_purchase: *716 + organization: *690 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -148704,7 +148408,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *692 + repository: *691 sender: *4 required: - action @@ -148785,8 +148489,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 marketplace_purchase: title: Marketplace Purchase type: object @@ -148872,9 +148576,9 @@ webhooks: type: integer unit_count: type: integer - organization: *691 - previous_marketplace_purchase: *718 - repository: *692 + organization: *690 + previous_marketplace_purchase: *717 + repository: *691 sender: *4 required: - action @@ -148954,12 +148658,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *689 - installation: *690 - marketplace_purchase: *717 - organization: *691 - previous_marketplace_purchase: *718 - repository: *692 + enterprise: *688 + installation: *689 + marketplace_purchase: *716 + organization: *690 + previous_marketplace_purchase: *717 + repository: *691 sender: *4 required: - action @@ -149061,11 +148765,11 @@ webhooks: type: string required: - to - enterprise: *689 - installation: *690 - member: *709 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + member: *708 + organization: *690 + repository: *691 sender: *4 required: - action @@ -149167,11 +148871,11 @@ webhooks: type: - string - 'null' - enterprise: *689 - installation: *690 - member: *709 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + member: *708 + organization: *690 + repository: *691 sender: *4 required: - action @@ -149250,11 +148954,11 @@ webhooks: type: string enum: - removed - enterprise: *689 - installation: *690 - member: *709 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + member: *708 + organization: *690 + repository: *691 sender: *4 required: - action @@ -149332,11 +149036,11 @@ webhooks: type: string enum: - added - enterprise: *689 - installation: *690 - member: *709 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + member: *708 + organization: *690 + repository: *691 scope: description: The scope of the membership. Currently, can only be `team`. @@ -149414,7 +149118,7 @@ webhooks: required: - login - id - team: &719 + team: &718 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -149644,11 +149348,11 @@ webhooks: type: string enum: - removed - enterprise: *689 - installation: *690 - member: *709 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + member: *708 + organization: *690 + repository: *691 scope: description: The scope of the membership. Currently, can only be `team`. @@ -149727,7 +149431,7 @@ webhooks: required: - login - id - team: *719 + team: *718 required: - action - scope @@ -149809,8 +149513,8 @@ webhooks: type: string enum: - checks_requested - installation: *690 - merge_group: &720 + installation: *689 + merge_group: &719 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -149829,15 +149533,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *393 + head_commit: *391 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -149923,10 +149627,10 @@ webhooks: - merged - invalidated - dequeued - installation: *690 - merge_group: *720 - organization: *691 - repository: *692 + installation: *689 + merge_group: *719 + organization: *690 + repository: *691 sender: *4 required: - action @@ -149999,7 +149703,7 @@ webhooks: type: string enum: - deleted - enterprise: *689 + enterprise: *688 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -150108,12 +149812,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *690 - organization: *691 + installation: *689 + organization: *690 repository: anyOf: - type: 'null' - - *692 + - *691 sender: *4 required: - action @@ -150193,11 +149897,11 @@ webhooks: type: string enum: - closed - enterprise: *689 - installation: *690 - milestone: *714 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + milestone: *713 + organization: *690 + repository: *691 sender: *4 required: - action @@ -150276,9 +149980,9 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - milestone: &721 + enterprise: *688 + installation: *689 + milestone: &720 title: Milestone description: A collection of related issues and pull requests. type: object @@ -150420,8 +150124,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -150500,11 +150204,11 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - milestone: *714 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + milestone: *713 + organization: *690 + repository: *691 sender: *4 required: - action @@ -150614,11 +150318,11 @@ webhooks: type: string required: - from - enterprise: *689 - installation: *690 - milestone: *714 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + milestone: *713 + organization: *690 + repository: *691 sender: *4 required: - action @@ -150698,11 +150402,11 @@ webhooks: type: string enum: - opened - enterprise: *689 - installation: *690 - milestone: *721 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + milestone: *720 + organization: *690 + repository: *691 sender: *4 required: - action @@ -150781,11 +150485,11 @@ webhooks: type: string enum: - blocked - blocked_user: *709 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + blocked_user: *708 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -150864,11 +150568,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *709 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + blocked_user: *708 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -150947,9 +150651,9 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - membership: &722 + enterprise: *688 + installation: *689 + membership: &721 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -151059,8 +150763,8 @@ webhooks: - role - organization_url - user - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -151138,11 +150842,11 @@ webhooks: type: string enum: - member_added - enterprise: *689 - installation: *690 - membership: *722 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + membership: *721 + organization: *690 + repository: *691 sender: *4 required: - action @@ -151221,8 +150925,8 @@ webhooks: type: string enum: - member_invited - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -151344,10 +151048,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 - user: *709 + user: *708 required: - action - invitation @@ -151425,11 +151129,11 @@ webhooks: type: string enum: - member_removed - enterprise: *689 - installation: *690 - membership: *722 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + membership: *721 + organization: *690 + repository: *691 sender: *4 required: - action @@ -151516,11 +151220,11 @@ webhooks: properties: from: type: string - enterprise: *689 - installation: *690 - membership: *722 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + membership: *721 + organization: *690 + repository: *691 sender: *4 required: - action @@ -151596,9 +151300,9 @@ webhooks: type: string enum: - published - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 package: description: Information about the package. type: object @@ -152121,7 +151825,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &723 + items: &722 title: Ruby Gems metadata type: object properties: @@ -152218,7 +151922,7 @@ webhooks: - owner - package_version - registry - repository: *692 + repository: *691 sender: *4 required: - action @@ -152294,9 +151998,9 @@ webhooks: type: string enum: - updated - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 package: description: Information about the package. type: object @@ -152658,7 +152362,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *723 + items: *722 source_url: type: string format: uri @@ -152729,7 +152433,7 @@ webhooks: - owner - package_version - registry - repository: *692 + repository: *691 sender: *4 required: - action @@ -152910,12 +152614,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *689 + enterprise: *688 id: type: integer - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - id @@ -152992,7 +152696,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &724 + personal_access_token_request: &723 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -153142,10 +152846,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *689 - organization: *691 + enterprise: *688 + organization: *690 sender: *4 - installation: *690 + installation: *689 required: - action - personal_access_token_request @@ -153222,11 +152926,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *724 - enterprise: *689 - organization: *691 + personal_access_token_request: *723 + enterprise: *688 + organization: *690 sender: *4 - installation: *690 + installation: *689 required: - action - personal_access_token_request @@ -153302,11 +153006,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *724 - enterprise: *689 - organization: *691 + personal_access_token_request: *723 + enterprise: *688 + organization: *690 sender: *4 - installation: *690 + installation: *689 required: - action - personal_access_token_request @@ -153381,11 +153085,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *724 - organization: *691 - enterprise: *689 + personal_access_token_request: *723 + organization: *690 + enterprise: *688 sender: *4 - installation: *690 + installation: *689 required: - action - personal_access_token_request @@ -153490,7 +153194,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *725 + last_response: *724 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -153522,8 +153226,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 zen: description: Random string of GitHub zen. @@ -153768,10 +153472,10 @@ webhooks: - from required: - note - enterprise: *689 - installation: *690 - organization: *691 - project_card: &726 + enterprise: *688 + installation: *689 + organization: *690 + project_card: &725 title: Project Card type: object properties: @@ -153894,7 +153598,7 @@ webhooks: - creator - created_at - updated_at - repository: *692 + repository: *691 sender: *4 required: - action @@ -153975,11 +153679,11 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 - project_card: *726 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + project_card: *725 + repository: *691 sender: *4 required: - action @@ -154059,9 +153763,9 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 project_card: title: Project Card type: object @@ -154191,7 +153895,7 @@ webhooks: repository: anyOf: - type: 'null' - - *692 + - *691 sender: *4 required: - action @@ -154285,11 +153989,11 @@ webhooks: - from required: - note - enterprise: *689 - installation: *690 - organization: *691 - project_card: *726 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + project_card: *725 + repository: *691 sender: *4 required: - action @@ -154383,9 +154087,9 @@ webhooks: - from required: - column_id - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 project_card: allOf: - title: Project Card @@ -154582,7 +154286,7 @@ webhooks: type: string required: - after_id - repository: *692 + repository: *691 sender: *4 required: - action @@ -154662,10 +154366,10 @@ webhooks: type: string enum: - closed - enterprise: *689 - installation: *690 - organization: *691 - project: &728 + enterprise: *688 + installation: *689 + organization: *690 + project: &727 title: Project type: object properties: @@ -154792,7 +154496,7 @@ webhooks: - creator - created_at - updated_at - repository: *692 + repository: *691 sender: *4 required: - action @@ -154872,10 +154576,10 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 - project_column: &727 + enterprise: *688 + installation: *689 + organization: *690 + project_column: &726 title: Project Column type: object properties: @@ -154915,7 +154619,7 @@ webhooks: - name - created_at - updated_at - repository: *692 + repository: *691 sender: *4 required: - action @@ -154994,14 +154698,14 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - organization: *691 - project_column: *727 + enterprise: *688 + installation: *689 + organization: *690 + project_column: *726 repository: anyOf: - type: 'null' - - *692 + - *691 sender: *4 required: - action @@ -155090,11 +154794,11 @@ webhooks: type: string required: - from - enterprise: *689 - installation: *690 - organization: *691 - project_column: *727 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + project_column: *726 + repository: *691 sender: *4 required: - action @@ -155174,11 +154878,11 @@ webhooks: type: string enum: - moved - enterprise: *689 - installation: *690 - organization: *691 - project_column: *727 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + project_column: *726 + repository: *691 sender: *4 required: - action @@ -155258,11 +154962,11 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 - project: *728 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + project: *727 + repository: *691 sender: *4 required: - action @@ -155342,14 +155046,14 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - organization: *691 - project: *728 + enterprise: *688 + installation: *689 + organization: *690 + project: *727 repository: anyOf: - type: 'null' - - *692 + - *691 sender: *4 required: - action @@ -155450,11 +155154,11 @@ webhooks: type: string required: - from - enterprise: *689 - installation: *690 - organization: *691 - project: *728 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + project: *727 + repository: *691 sender: *4 required: - action @@ -155533,11 +155237,11 @@ webhooks: type: string enum: - reopened - enterprise: *689 - installation: *690 - organization: *691 - project: *728 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + project: *727 + repository: *691 sender: *4 required: - action @@ -155618,8 +155322,8 @@ webhooks: type: string enum: - closed - installation: *690 - organization: *691 + installation: *689 + organization: *690 projects_v2: *239 sender: *4 required: @@ -155701,8 +155405,8 @@ webhooks: type: string enum: - created - installation: *690 - organization: *691 + installation: *689 + organization: *690 projects_v2: *239 sender: *4 required: @@ -155784,8 +155488,8 @@ webhooks: type: string enum: - deleted - installation: *690 - organization: *691 + installation: *689 + organization: *690 projects_v2: *239 sender: *4 required: @@ -155907,8 +155611,8 @@ webhooks: type: string to: type: string - installation: *690 - organization: *691 + installation: *689 + organization: *690 projects_v2: *239 sender: *4 required: @@ -155992,7 +155696,7 @@ webhooks: type: string enum: - archived - changes: &732 + changes: &731 type: object properties: archived_at: @@ -156008,9 +155712,9 @@ webhooks: - string - 'null' format: date-time - installation: *690 - organization: *691 - projects_v2_item: &729 + installation: *689 + organization: *690 + projects_v2_item: &728 title: Projects v2 Item description: An item belonging to a project type: object @@ -156150,9 +155854,9 @@ webhooks: - 'null' to: type: string - installation: *690 - organization: *691 - projects_v2_item: *729 + installation: *689 + organization: *690 + projects_v2_item: *728 sender: *4 required: - action @@ -156234,9 +155938,9 @@ webhooks: type: string enum: - created - installation: *690 - organization: *691 - projects_v2_item: *729 + installation: *689 + organization: *690 + projects_v2_item: *728 sender: *4 required: - action @@ -156317,9 +156021,9 @@ webhooks: type: string enum: - deleted - installation: *690 - organization: *691 - projects_v2_item: *729 + installation: *689 + organization: *690 + projects_v2_item: *728 sender: *4 required: - action @@ -156424,7 +156128,7 @@ webhooks: oneOf: - type: string - type: integer - - &730 + - &729 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -156448,7 +156152,7 @@ webhooks: required: - id - name - - &731 + - &730 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -156488,8 +156192,8 @@ webhooks: oneOf: - type: string - type: integer + - *729 - *730 - - *731 type: - 'null' - string @@ -156512,9 +156216,9 @@ webhooks: - 'null' required: - body - installation: *690 - organization: *691 - projects_v2_item: *729 + installation: *689 + organization: *690 + projects_v2_item: *728 sender: *4 required: - action @@ -156611,9 +156315,9 @@ webhooks: type: - string - 'null' - installation: *690 - organization: *691 - projects_v2_item: *729 + installation: *689 + organization: *690 + projects_v2_item: *728 sender: *4 required: - action @@ -156696,10 +156400,10 @@ webhooks: type: string enum: - restored - changes: *732 - installation: *690 - organization: *691 - projects_v2_item: *729 + changes: *731 + installation: *689 + organization: *690 + projects_v2_item: *728 sender: *4 required: - action @@ -156781,8 +156485,8 @@ webhooks: type: string enum: - reopened - installation: *690 - organization: *691 + installation: *689 + organization: *690 projects_v2: *239 sender: *4 required: @@ -156864,9 +156568,9 @@ webhooks: type: string enum: - created - installation: *690 - organization: *691 - projects_v2_status_update: *733 + installation: *689 + organization: *690 + projects_v2_status_update: *732 sender: *4 required: - action @@ -156947,9 +156651,9 @@ webhooks: type: string enum: - deleted - installation: *690 - organization: *691 - projects_v2_status_update: *733 + installation: *689 + organization: *690 + projects_v2_status_update: *732 sender: *4 required: - action @@ -157095,9 +156799,9 @@ webhooks: - string - 'null' format: date - installation: *690 - organization: *691 - projects_v2_status_update: *733 + installation: *689 + organization: *690 + projects_v2_status_update: *732 sender: *4 required: - action @@ -157168,10 +156872,10 @@ webhooks: title: public event type: object properties: - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - repository @@ -157248,13 +156952,13 @@ webhooks: type: string enum: - assigned - assignee: *709 - enterprise: *689 - installation: *690 - number: &734 + assignee: *708 + enterprise: *688 + installation: *689 + number: &733 description: The pull request number. type: integer - organization: *691 + organization: *690 pull_request: title: Pull Request type: object @@ -159603,7 +159307,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 sender: *4 required: - action @@ -159685,11 +159389,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 number: type: integer - organization: *691 + organization: *690 pull_request: title: Pull Request type: object @@ -162031,7 +161735,7 @@ webhooks: - draft reason: type: string - repository: *692 + repository: *691 sender: *4 required: - action @@ -162113,11 +161817,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 number: type: integer - organization: *691 + organization: *690 pull_request: title: Pull Request type: object @@ -164459,7 +164163,7 @@ webhooks: - draft reason: type: string - repository: *692 + repository: *691 sender: *4 required: - action @@ -164541,13 +164245,13 @@ webhooks: type: string enum: - closed - enterprise: *689 - installation: *690 - number: *734 - organization: *691 - pull_request: &735 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 + pull_request: &734 allOf: - - *545 + - *544 - type: object properties: allow_auto_merge: @@ -164609,7 +164313,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *692 + repository: *691 sender: *4 required: - action @@ -164690,12 +164394,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *689 - installation: *690 - number: *734 - organization: *691 - pull_request: *735 - repository: *692 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 + pull_request: *734 + repository: *691 sender: *4 required: - action @@ -164775,11 +164479,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *689 + enterprise: *688 milestone: *243 - number: *734 - organization: *691 - pull_request: &736 + number: *733 + organization: *690 + pull_request: &735 title: Pull Request type: object properties: @@ -167106,7 +166810,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 sender: *4 required: - action @@ -167185,11 +166889,11 @@ webhooks: type: string enum: - dequeued - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 number: type: integer - organization: *691 + organization: *690 pull_request: title: Pull Request type: object @@ -169535,7 +169239,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *692 + repository: *691 sender: *4 required: - action @@ -169659,12 +169363,12 @@ webhooks: type: string required: - from - enterprise: *689 - installation: *690 - number: *734 - organization: *691 - pull_request: *735 - repository: *692 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 + pull_request: *734 + repository: *691 sender: *4 required: - action @@ -169744,11 +169448,11 @@ webhooks: type: string enum: - enqueued - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 number: type: integer - organization: *691 + organization: *690 pull_request: title: Pull Request type: object @@ -172079,7 +171783,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 sender: *4 required: - action @@ -172159,11 +171863,11 @@ webhooks: type: string enum: - labeled - enterprise: *689 - installation: *690 - label: *708 - number: *734 - organization: *691 + enterprise: *688 + installation: *689 + label: *707 + number: *733 + organization: *690 pull_request: title: Pull Request type: object @@ -174511,7 +174215,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 sender: *4 required: - action @@ -174592,10 +174296,10 @@ webhooks: type: string enum: - locked - enterprise: *689 - installation: *690 - number: *734 - organization: *691 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 pull_request: title: Pull Request type: object @@ -176941,7 +176645,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 sender: *4 required: - action @@ -177021,12 +176725,12 @@ webhooks: type: string enum: - milestoned - enterprise: *689 + enterprise: *688 milestone: *243 - number: *734 - organization: *691 - pull_request: *736 - repository: *692 + number: *733 + organization: *690 + pull_request: *735 + repository: *691 sender: *4 required: - action @@ -177105,12 +176809,12 @@ webhooks: type: string enum: - opened - enterprise: *689 - installation: *690 - number: *734 - organization: *691 - pull_request: *735 - repository: *692 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 + pull_request: *734 + repository: *691 sender: *4 required: - action @@ -177191,12 +176895,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *689 - installation: *690 - number: *734 - organization: *691 - pull_request: *735 - repository: *692 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 + pull_request: *734 + repository: *691 sender: *4 required: - action @@ -177276,12 +176980,12 @@ webhooks: type: string enum: - reopened - enterprise: *689 - installation: *690 - number: *734 - organization: *691 - pull_request: *735 - repository: *692 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 + pull_request: *734 + repository: *691 sender: *4 required: - action @@ -177656,9 +177360,9 @@ webhooks: - start_side - side - reactions - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 pull_request: type: object properties: @@ -179888,7 +179592,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *692 + repository: *691 sender: *4 required: - action @@ -179968,7 +179672,7 @@ webhooks: type: string enum: - deleted - comment: &738 + comment: &737 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -180261,9 +179965,9 @@ webhooks: - start_side - side - reactions - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 pull_request: type: object properties: @@ -182481,7 +182185,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *692 + repository: *691 sender: *4 required: - action @@ -182561,11 +182265,11 @@ webhooks: type: string enum: - edited - changes: *737 - comment: *738 - enterprise: *689 - installation: *690 - organization: *691 + changes: *736 + comment: *737 + enterprise: *688 + installation: *689 + organization: *690 pull_request: type: object properties: @@ -184786,7 +184490,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *692 + repository: *691 sender: *4 required: - action @@ -184867,9 +184571,9 @@ webhooks: type: string enum: - dismissed - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 pull_request: title: Simple Pull Request type: object @@ -187102,7 +186806,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *692 + repository: *691 review: description: The review that was affected. type: object @@ -187353,9 +187057,9 @@ webhooks: type: string required: - from - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 pull_request: title: Simple Pull Request type: object @@ -189469,8 +189173,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *692 - review: &739 + repository: *691 + review: &738 description: The review that was affected. type: object properties: @@ -189708,12 +189412,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 number: description: The pull request number. type: integer - organization: *691 + organization: *690 pull_request: title: Pull Request type: object @@ -192060,7 +191764,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 requested_reviewer: title: User type: @@ -192146,12 +191850,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 number: description: The pull request number. type: integer - organization: *691 + organization: *690 pull_request: title: Pull Request type: object @@ -194505,7 +194209,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 requested_team: title: Team description: Groups of organization members that gives permissions @@ -194700,12 +194404,12 @@ webhooks: type: string enum: - review_requested - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 number: description: The pull request number. type: integer - organization: *691 + organization: *690 pull_request: title: Pull Request type: object @@ -197054,7 +196758,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 requested_reviewer: title: User type: @@ -197141,12 +196845,12 @@ webhooks: type: string enum: - review_requested - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 number: description: The pull request number. type: integer - organization: *691 + organization: *690 pull_request: title: Pull Request type: object @@ -199486,7 +199190,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 requested_team: title: Team description: Groups of organization members that gives permissions @@ -199670,9 +199374,9 @@ webhooks: type: string enum: - submitted - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 pull_request: title: Simple Pull Request type: object @@ -201908,8 +201612,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *692 - review: *739 + repository: *691 + review: *738 sender: *4 required: - action @@ -201989,9 +201693,9 @@ webhooks: type: string enum: - resolved - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 pull_request: title: Simple Pull Request type: object @@ -204122,7 +203826,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *692 + repository: *691 sender: *4 thread: type: object @@ -204519,9 +204223,9 @@ webhooks: type: string enum: - unresolved - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 pull_request: title: Simple Pull Request type: object @@ -206635,7 +206339,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *692 + repository: *691 sender: *4 thread: type: object @@ -207034,10 +206738,10 @@ webhooks: type: string before: type: string - enterprise: *689 - installation: *690 - number: *734 - organization: *691 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 pull_request: title: Pull Request type: object @@ -209372,7 +209076,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 sender: *4 required: - action @@ -209454,11 +209158,11 @@ webhooks: type: string enum: - unassigned - assignee: *740 - enterprise: *689 - installation: *690 - number: *734 - organization: *691 + assignee: *739 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 pull_request: title: Pull Request type: object @@ -211808,7 +211512,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 sender: *4 required: - action @@ -211887,11 +211591,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *689 - installation: *690 - label: *708 - number: *734 - organization: *691 + enterprise: *688 + installation: *689 + label: *707 + number: *733 + organization: *690 pull_request: title: Pull Request type: object @@ -214230,7 +213934,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 sender: *4 required: - action @@ -214311,10 +214015,10 @@ webhooks: type: string enum: - unlocked - enterprise: *689 - installation: *690 - number: *734 - organization: *691 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 pull_request: title: Pull Request type: object @@ -216643,7 +216347,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 sender: *4 required: - action @@ -216846,7 +216550,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *689 + enterprise: *688 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -216941,8 +216645,8 @@ webhooks: - url - author - committer - installation: *690 - organization: *691 + installation: *689 + organization: *690 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -217530,9 +217234,9 @@ webhooks: type: string enum: - published - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 registry_package: type: object properties: @@ -218009,7 +217713,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *723 + items: *722 summary: type: string tag_name: @@ -218065,7 +217769,7 @@ webhooks: - owner - package_version - registry - repository: *692 + repository: *691 sender: *4 required: - action @@ -218143,9 +217847,9 @@ webhooks: type: string enum: - updated - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 registry_package: type: object properties: @@ -218457,7 +218161,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *723 + items: *722 summary: type: string tag_name: @@ -218507,7 +218211,7 @@ webhooks: - owner - package_version - registry - repository: *692 + repository: *691 sender: *4 required: - action @@ -218584,10 +218288,10 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 - release: &741 + enterprise: *688 + installation: *689 + organization: *690 + release: &740 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -218918,7 +218622,7 @@ webhooks: - updated_at - zipball_url - body - repository: *692 + repository: *691 sender: *4 required: - action @@ -218995,11 +218699,11 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - organization: *691 - release: *741 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + release: *740 + repository: *691 sender: *4 required: - action @@ -219116,11 +218820,11 @@ webhooks: type: boolean required: - to - enterprise: *689 - installation: *690 - organization: *691 - release: *741 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + release: *740 + repository: *691 sender: *4 required: - action @@ -219198,9 +218902,9 @@ webhooks: type: string enum: - prereleased - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -219536,7 +219240,7 @@ webhooks: - string - 'null' format: uri - repository: *692 + repository: *691 sender: *4 required: - action @@ -219612,10 +219316,10 @@ webhooks: type: string enum: - published - enterprise: *689 - installation: *690 - organization: *691 - release: &742 + enterprise: *688 + installation: *689 + organization: *690 + release: &741 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -219948,7 +219652,7 @@ webhooks: - string - 'null' format: uri - repository: *692 + repository: *691 sender: *4 required: - action @@ -220024,11 +219728,11 @@ webhooks: type: string enum: - released - enterprise: *689 - installation: *690 - organization: *691 - release: *741 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + release: *740 + repository: *691 sender: *4 required: - action @@ -220104,11 +219808,11 @@ webhooks: type: string enum: - unpublished - enterprise: *689 - installation: *690 - organization: *691 - release: *742 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + release: *741 + repository: *691 sender: *4 required: - action @@ -220184,11 +219888,11 @@ webhooks: type: string enum: - published - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 - repository_advisory: *609 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 + repository_advisory: *608 sender: *4 required: - action @@ -220264,11 +219968,11 @@ webhooks: type: string enum: - reported - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 - repository_advisory: *609 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 + repository_advisory: *608 sender: *4 required: - action @@ -220344,10 +220048,10 @@ webhooks: type: string enum: - archived - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -220424,10 +220128,10 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -220505,10 +220209,10 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -220593,10 +220297,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -220711,10 +220415,10 @@ webhooks: - 'null' items: type: string - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -220786,10 +220490,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 status: type: string @@ -220870,10 +220574,10 @@ webhooks: type: string enum: - privatized - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -220950,10 +220654,10 @@ webhooks: type: string enum: - publicized - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -221047,10 +220751,10 @@ webhooks: - name required: - repository - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -221130,10 +220834,10 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 repository_ruleset: *280 sender: *4 required: @@ -221212,10 +220916,10 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 repository_ruleset: *280 sender: *4 required: @@ -221294,10 +220998,10 @@ webhooks: type: string enum: - edited - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 repository_ruleset: *280 changes: type: object @@ -221359,16 +221063,16 @@ webhooks: properties: added: type: array - items: *566 + items: *565 deleted: type: array - items: *566 + items: *565 updated: type: array items: type: object properties: - rule: *566 + rule: *565 changes: type: object properties: @@ -221605,10 +221309,10 @@ webhooks: - from required: - owner - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -221686,10 +221390,10 @@ webhooks: type: string enum: - unarchived - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -221767,7 +221471,7 @@ webhooks: type: string enum: - create - alert: &743 + alert: &742 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -221891,10 +221595,10 @@ webhooks: type: string enum: - open - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -222104,10 +221808,10 @@ webhooks: type: string enum: - dismissed - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -222185,11 +221889,11 @@ webhooks: type: string enum: - reopen - alert: *743 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + alert: *742 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -222391,10 +222095,10 @@ webhooks: enum: - fixed - open - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -222472,17 +222176,17 @@ webhooks: type: string enum: - created - alert: &744 + alert: &743 type: object properties: - number: *151 - created_at: *152 + number: *152 + created_at: *153 updated_at: anyOf: - type: 'null' - - *153 - url: *154 - html_url: *155 + - *154 + url: *155 + html_url: *156 locations_url: type: string format: uri @@ -222586,10 +222290,10 @@ webhooks: anyOf: - type: 'null' - *4 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -222670,11 +222374,11 @@ webhooks: type: string enum: - created - alert: *744 - installation: *690 - location: *745 - organization: *691 - repository: *692 + alert: *743 + installation: *689 + location: *744 + organization: *690 + repository: *691 sender: *4 required: - location @@ -222912,11 +222616,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *744 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + alert: *743 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -222994,11 +222698,11 @@ webhooks: type: string enum: - reopened - alert: *744 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + alert: *743 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -223076,11 +222780,11 @@ webhooks: type: string enum: - resolved - alert: *744 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + alert: *743 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -223158,11 +222862,11 @@ webhooks: type: string enum: - validated - alert: *744 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + alert: *743 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -223292,10 +222996,10 @@ webhooks: - organization - enterprise - - repository: *692 - enterprise: *689 - installation: *690 - organization: *691 + repository: *691 + enterprise: *688 + installation: *689 + organization: *690 sender: *4 required: - action @@ -223373,11 +223077,11 @@ webhooks: type: string enum: - published - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 - security_advisory: &746 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 + security_advisory: &745 description: The details of the security advisory, including summary, description, and severity. type: object @@ -223563,11 +223267,11 @@ webhooks: type: string enum: - updated - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 - security_advisory: *746 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 + security_advisory: *745 sender: *4 required: - action @@ -223640,10 +223344,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -223830,10 +223534,10 @@ webhooks: type: object properties: security_and_analysis: *254 - enterprise: *689 - installation: *690 - organization: *691 - repository: *316 + enterprise: *688 + installation: *689 + organization: *690 + repository: *314 sender: *4 required: - changes @@ -223911,12 +223615,12 @@ webhooks: type: string enum: - cancelled - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - sponsorship: &747 + sponsorship: &746 type: object properties: created_at: @@ -224221,12 +223925,12 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - sponsorship: *747 + sponsorship: *746 required: - action - sponsorship @@ -224314,12 +224018,12 @@ webhooks: type: string required: - from - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - sponsorship: *747 + sponsorship: *746 required: - action - changes @@ -224396,17 +224100,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &748 + effective_date: &747 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: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - sponsorship: *747 + sponsorship: *746 required: - action - sponsorship @@ -224480,7 +224184,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &749 + changes: &748 type: object properties: tier: @@ -224524,13 +224228,13 @@ webhooks: - from required: - tier - effective_date: *748 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + effective_date: *747 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - sponsorship: *747 + sponsorship: *746 required: - action - changes @@ -224607,13 +224311,13 @@ webhooks: type: string enum: - tier_changed - changes: *749 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + changes: *748 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - sponsorship: *747 + sponsorship: *746 required: - action - changes @@ -224687,10 +224391,10 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -224774,10 +224478,10 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -225211,15 +224915,15 @@ webhooks: type: - string - 'null' - enterprise: *689 + enterprise: *688 id: description: The unique identifier of the status. type: integer - installation: *690 + installation: *689 name: type: string - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 sha: description: The Commit SHA. @@ -225335,9 +225039,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *78 - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -225427,9 +225131,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *78 - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -225519,9 +225223,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *78 - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -225611,9 +225315,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *78 - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -225690,12 +225394,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - team: &750 + team: &749 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -225925,9 +225629,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 repository: title: Repository description: A git repository @@ -226397,7 +226101,7 @@ webhooks: - topics - visibility sender: *4 - team: *750 + team: *749 required: - action - team @@ -226473,9 +226177,9 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 repository: title: Repository description: A git repository @@ -226945,7 +226649,7 @@ webhooks: - topics - visibility sender: *4 - team: *750 + team: *749 required: - action - team @@ -227022,9 +226726,9 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 repository: title: Repository description: A git repository @@ -227494,7 +227198,7 @@ webhooks: - topics - visibility sender: *4 - team: *750 + team: *749 required: - action - team @@ -227638,9 +227342,9 @@ webhooks: - from required: - permissions - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 repository: title: Repository description: A git repository @@ -228110,7 +227814,7 @@ webhooks: - topics - visibility sender: *4 - team: *750 + team: *749 required: - action - changes @@ -228188,9 +227892,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 repository: title: Repository description: A git repository @@ -228660,7 +228364,7 @@ webhooks: - topics - visibility sender: *4 - team: *750 + team: *749 required: - action - team @@ -228736,10 +228440,10 @@ webhooks: type: string enum: - started - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -228812,17 +228516,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *689 + enterprise: *688 inputs: type: - object - 'null' additionalProperties: true - installation: *690 - organization: *691 + installation: *689 + organization: *690 ref: type: string - repository: *692 + repository: *691 sender: *4 workflow: type: string @@ -228904,10 +228608,10 @@ webhooks: type: string enum: - completed - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 workflow_job: allOf: @@ -229163,7 +228867,7 @@ webhooks: type: string required: - conclusion - deployment: *462 + deployment: *460 required: - action - repository @@ -229242,10 +228946,10 @@ webhooks: type: string enum: - in_progress - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 workflow_job: allOf: @@ -229527,7 +229231,7 @@ webhooks: required: - status - steps - deployment: *462 + deployment: *460 required: - action - repository @@ -229606,10 +229310,10 @@ webhooks: type: string enum: - queued - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 workflow_job: type: object @@ -229755,7 +229459,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *462 + deployment: *460 required: - action - repository @@ -229834,10 +229538,10 @@ webhooks: type: string enum: - waiting - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 workflow_job: type: object @@ -229984,7 +229688,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *462 + deployment: *460 required: - action - repository @@ -230064,12 +229768,12 @@ webhooks: type: string enum: - completed - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - workflow: *704 + workflow: *703 workflow_run: title: Workflow Run type: object @@ -231088,12 +230792,12 @@ webhooks: type: string enum: - in_progress - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - workflow: *704 + workflow: *703 workflow_run: title: Workflow Run type: object @@ -232097,12 +231801,12 @@ webhooks: type: string enum: - requested - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - workflow: *704 + workflow: *703 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 818f8ff31..e1a28617e 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -61612,6 +61612,1320 @@ } } }, + "/organizations/{org}/settings/billing/budgets": { + "get": { + "summary": "Get all budgets for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all budgets for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-all-budgets-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-all-budgets-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 when getting all budgets", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "budgets": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the budget", + "examples": [ + "2066deda-923f-43f9-88d2-62395a28c0cdd" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "SkuPricing", + "ProductPricing" + ], + "examples": [ + "SkuPricing" + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount limit in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "The type of limit enforcement for the budget", + "examples": [ + true + ] + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "examples": [ + "octocat/hello-world" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to." + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + }, + "required": [ + "will_alert", + "alert_recipients" + ] + } + }, + "required": [ + "id", + "budget_type", + "budget_product_sku", + "budget_scope", + "budget_amount", + "prevent_further_usage", + "budget_alerting" + ] + }, + "description": "Array of budget objects for the enterprise" + } + }, + "required": [ + "budgets" + ] + }, + "examples": { + "default": { + "value": { + "budgets": [ + { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "actions" + ], + "budget_scope": "enterprise", + "budget_amount": 1000.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "enterprise-admin", + "billing-manager" + ] + } + }, + { + "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", + "budget_type": "SkuPricing", + "budget_product_skus": [ + "actions_linux" + ], + "budget_scope": "organization", + "budget_amount": 500.0, + "prevent_further_usage": false, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "org-owner" + ] + } + }, + { + "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "packages" + ], + "budget_scope": "cost_center", + "budget_amount": 250.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + ] + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, + "/organizations/{org}/settings/billing/budgets/{budget_id}": { + "get": { + "summary": "Get a budget by ID for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a budget by ID. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-a-budget-by-id-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "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 updating a budget", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ], + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "examples": [ + "octocat/hello-world" + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "examples": [ + true + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "examples": [ + "actions_linux" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ], + "examples": [ + "ProductPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + } + } + }, + "required": [ + "id", + "budget_amount", + "prevent_further_usage", + "budget_product_sku", + "budget_type", + "budget_alerting", + "budget_scope", + "budget_entity_name" + ] + }, + "examples": { + "default": { + "value": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "patch": { + "summary": "Update a budget for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nUpdates an existing budget for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/update-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "budget_id", + "description": "The ID corresponding to the budget.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + }, + "examples": { + "update-budget": { + "summary": "Update budget example", + "value": { + "prevent_further_usage": false, + "budget_amount": 10, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Budget updated successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": [ + "Budget successfully updated." + ] + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "required": [ + "will_alert", + "alert_recipients" + ], + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "default": "" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + } + } + }, + "examples": { + "update-budget": { + "value": { + "message": "Budget successfully updated.", + "id": "550e8400-e29b-41d4-a716-446655440000" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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/enhanced-billing#update-a-budget" + } + }, + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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 update budget.", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "delete": { + "summary": "Delete a budget for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/delete-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/enhanced-billing#delete-a-budget-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", @@ -62309,7 +63623,7 @@ }, "/organizations/{org}/settings/billing/usage/summary": { "get": { - "summary": "Get billing usage summary report for an organization", + "summary": "Get billing usage summary for an organization", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" @@ -62317,7 +63631,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-report-for-an-organization" + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-for-an-organization" }, "parameters": [ { @@ -62386,7 +63700,7 @@ ], "responses": { "200": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { @@ -147419,999 +148733,6 @@ } } }, - "/orgs/{org}/projects": { - "get": { - "summary": "List organization 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#list-organization-projects" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - } - }, - "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": true - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create an organization 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#create-an-organization-project" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the project." - }, - "body": { - "type": "string", - "description": "The description of the project." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "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" - } - } - } - } - } - }, - "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": "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/orgs/{org}/projectsV2": { "get": { "summary": "List projects for organization", @@ -207200,1125 +207521,6 @@ "deprecated": true } }, - "/projects/{project_id}": { - "get": { - "summary": "Get 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": [ - "projects-classic" - ], - "operationId": "projects-classic/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#get-a-project" - }, - "parameters": [ - { - "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": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "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": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update 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.", - "operationId": "projects-classic/update", - "tags": [ - "projects-classic" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#update-a-project" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone.", - "type": "boolean" - } - }, - "type": "object" - }, - "examples": { - "default": { - "summary": "Change the name, state, and permissions for a project", - "value": { - "name": "Week One Sprint", - "state": "open", - "organization_permission": "write" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "404": { - "description": "Not Found if the authenticated user does not have access to the project" - }, - "304": { - "description": "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": { - "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete 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.", - "operationId": "projects-classic/delete", - "tags": [ - "projects-classic" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#delete-a-project" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Delete Success" - }, - "304": { - "description": "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": { - "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/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": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/projects/{project_id}/collaborators": { "get": { "summary": "List project collaborators", @@ -478399,1421 +477601,77 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pages", - "subcategory": "pages" - } - } - }, - "/repos/{owner}/{repo}/private-vulnerability-reporting": { - "get": { - "summary": "Check if private vulnerability reporting is enabled for a repository", - "description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".", - "tags": [ - "repos" - ], - "operationId": "repos/check-private-vulnerability-reporting", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-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": "Private vulnerability reporting status", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Whether or not private vulnerability reporting is enabled for the repository." - } - }, - "required": [ - "enabled" - ] - }, - "examples": { - "default": { - "value": { - "enabled": true - } - } - } - } - } - }, - "422": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" - } - }, - "put": { - "summary": "Enable private vulnerability reporting for a repository", - "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"", - "tags": [ - "repos" - ], - "operationId": "repos/enable-private-vulnerability-reporting", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-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": { - "204": { - "description": "A header with no content is returned." - }, - "422": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" - } - }, - "delete": { - "summary": "Disable private vulnerability reporting for a repository", - "description": "Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".", - "tags": [ - "repos" - ], - "operationId": "repos/disable-private-vulnerability-reporting", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-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": { - "204": { - "description": "A header with no content is returned." - }, - "422": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" - } - } - }, - "/repos/{owner}/{repo}/projects": { - "get": { - "summary": "List repository 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#list-repository-projects" - }, - "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" - } - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "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": "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create a repository 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#create-a-repository-project" - }, - "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": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the project." - }, - "body": { - "type": "string", - "description": "The description of the project." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "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": "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": "pages", + "subcategory": "pages" + } + } + }, + "/repos/{owner}/{repo}/private-vulnerability-reporting": { + "get": { + "summary": "Check if private vulnerability reporting is enabled for a repository", + "description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".", + "tags": [ + "repos" + ], + "operationId": "repos/check-private-vulnerability-reporting", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-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" + } }, - "410": { - "description": "Gone", + { + "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": "Private vulnerability reporting status", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether or not private vulnerability reporting is enabled for the repository." + } + }, + "required": [ + "enabled" + ] + }, + "examples": { + "default": { + "value": { + "enabled": true + } + } + } + } + } + }, + "422": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -479835,21 +477693,102 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + }, + "put": { + "summary": "Enable private vulnerability reporting for a repository", + "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"", + "tags": [ + "repos" + ], + "operationId": "repos/enable-private-vulnerability-reporting", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-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": { + "204": { + "description": "A header with no content is returned." }, "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "description": "Bad Request", "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -479857,7 +477796,49 @@ "documentation_url": { "type": "string" }, - "errors": { + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { "type": "array", "items": { "type": "string" @@ -479872,12 +477853,120 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" + "category": "repos", + "subcategory": "repos" + } + }, + "delete": { + "summary": "Disable private vulnerability reporting for a repository", + "description": "Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".", + "tags": [ + "repos" + ], + "operationId": "repos/disable-private-vulnerability-reporting", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository" }, - "deprecated": true + "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": { + "204": { + "description": "A header with no content is returned." + }, + "422": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } } }, "/repos/{owner}/{repo}/properties/values": { @@ -547179,8 +545268,12 @@ ] } }, - "required": [ - "state" + "anyOf": [ + { + "required": [ + "state" + ] + } ] }, "examples": { @@ -649247,498 +647340,6 @@ } } }, - "/user/projects": { - "post": { - "summary": "Create a user 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#create-a-user-project" - }, - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Create a new project", - "value": { - "name": "My Projects", - "body": "A board to manage my personal projects." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "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 Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/user/public_emails": { "get": { "summary": "List public email addresses for the authenticated user", @@ -686792,503 +684393,6 @@ } } }, - "/users/{username}/projects": { - "get": { - "summary": "List user 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/projects#list-user-projects" - }, - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/users/{username}/projectsV2": { "get": { "summary": "List projects for user", @@ -714740,7 +711844,7 @@ }, "/users/{username}/settings/billing/usage/summary": { "get": { - "summary": "Get billing usage summary report for a user", + "summary": "Get billing usage summary for a user", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" @@ -714748,7 +711852,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-report-for-a-user" + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-for-a-user" }, "parameters": [ { @@ -714817,7 +711921,7 @@ ], "responses": { "200": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 4c00cbb86..c1b6b0f1a 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -1040,7 +1040,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &105 + schema: &106 title: Validation Error Simple description: Validation Error Simple type: object @@ -1073,7 +1073,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &611 + - &610 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1658,7 +1658,7 @@ paths: schema: type: integer default: 30 - - &183 + - &184 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1674,7 +1674,7 @@ paths: application/json: schema: type: array - items: &184 + items: &185 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1770,7 +1770,7 @@ paths: - installation_id - repository_id examples: - default: &185 + default: &186 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1833,7 +1833,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &104 + schema: &105 title: Validation Error description: Validation Error type: object @@ -1905,7 +1905,7 @@ paths: description: Response content: application/json: - schema: &186 + schema: &187 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -2040,7 +2040,7 @@ paths: - request - response examples: - default: &187 + default: &188 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -7736,7 +7736,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &161 + code_scanning_options: &162 type: - object - 'null' @@ -7934,7 +7934,7 @@ paths: description: Response content: application/json: - schema: &163 + schema: &164 type: array description: A list of default code security configurations items: @@ -7950,7 +7950,7 @@ paths: default configuration: *41 examples: - default: &164 + default: &165 value: - default_for_new_repos: public configuration: @@ -8281,7 +8281,7 @@ paths: - *40 - *43 responses: - '204': &165 + '204': &166 description: A header with no content is returned. '400': *14 '403': *27 @@ -8408,7 +8408,7 @@ paths: default: value: default_for_new_repos: all - configuration: &162 + configuration: &163 value: id: 1325 target_type: organization @@ -8493,7 +8493,7 @@ paths: application/json: schema: type: array - items: &166 + items: &167 type: object description: Repositories associated with a code security configuration and attachment status @@ -8838,7 +8838,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &167 + repository: &168 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -8932,7 +8932,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &170 + - &171 name: state in: query description: |- @@ -8941,7 +8941,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &171 + - &172 name: severity in: query description: |- @@ -8950,7 +8950,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &172 + - &173 name: ecosystem in: query description: |- @@ -8959,14 +8959,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &173 + - &174 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &174 + - &175 name: epss_percentage in: query description: |- @@ -8978,7 +8978,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &453 + - &451 name: has in: query description: |- @@ -8992,7 +8992,7 @@ paths: type: string enum: - patch - - &175 + - &176 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -9002,7 +9002,7 @@ paths: enum: - development - runtime - - &176 + - &177 name: sort in: query description: |- @@ -9028,11 +9028,11 @@ paths: application/json: schema: type: array - items: &177 + items: &178 type: object description: A Dependabot alert. properties: - number: &151 + number: &152 type: integer description: The security alert number. readOnly: true @@ -9098,7 +9098,7 @@ paths: - direct - transitive - - security_advisory: &454 + security_advisory: &452 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9305,29 +9305,29 @@ paths: - withdrawn_at additionalProperties: false security_vulnerability: *50 - url: &154 + url: &155 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &155 + html_url: &156 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &152 + created_at: &153 type: string description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &153 + updated_at: &154 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: &157 + dismissed_at: &158 type: - string - 'null' @@ -9358,7 +9358,7 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: &156 + fixed_at: &157 type: - string - 'null' @@ -9366,7 +9366,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &455 + auto_dismissed_at: &453 type: - string - 'null' @@ -9393,7 +9393,7 @@ paths: - repository additionalProperties: false examples: - default: &178 + default: &179 value: - number: 2 state: dismissed @@ -10978,7 +10978,7 @@ paths: timeline_url: type: string format: uri - type: &205 + type: &206 title: Issue Type description: The type of issue. type: @@ -11087,7 +11087,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &623 + sub_issues_summary: &622 title: Sub-issues Summary type: object properties: @@ -11108,7 +11108,7 @@ paths: - string - 'null' format: uri - issue_dependencies_summary: &624 + issue_dependencies_summary: &623 title: Issue Dependencies Summary type: object properties: @@ -11127,7 +11127,7 @@ paths: - total_blocking issue_field_values: type: array - items: &625 + items: &624 title: Issue Field Value description: A value assigned to an issue field type: object @@ -11222,7 +11222,7 @@ paths: - user - created_at - updated_at - comment: &501 + comment: &500 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -11800,7 +11800,7 @@ paths: url: type: string format: uri - user: &637 + user: &636 title: Public User description: Public User type: object @@ -13695,7 +13695,7 @@ paths: - closed - all default: open - - &208 + - &209 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -13746,7 +13746,7 @@ paths: type: array items: *78 examples: - default: &209 + default: &210 value: - id: 1 node_id: MDU6SXNzdWUx @@ -15227,7 +15227,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &317 + '301': &315 description: Moved permanently content: application/json: @@ -15249,7 +15249,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &530 + - &529 name: all description: If `true`, show notifications marked as read. in: query @@ -15257,7 +15257,7 @@ paths: schema: type: boolean default: false - - &531 + - &530 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -15267,7 +15267,7 @@ paths: type: boolean default: false - *68 - - &532 + - &531 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -15299,7 +15299,7 @@ paths: properties: id: type: string - repository: &135 + repository: &136 title: Minimal Repository description: Minimal Repository type: object @@ -15803,7 +15803,7 @@ paths: - url - subscription_url examples: - default: &533 + default: &532 value: - id: '1' repository: @@ -16682,7 +16682,7 @@ paths: - property_name - value examples: - default: &539 + default: &538 value: - property_name: environment value: production @@ -16732,7 +16732,7 @@ paths: required: - properties examples: - default: &540 + default: &539 value: properties: - property_name: environment @@ -16753,6 +16753,495 @@ paths: enabledForGitHubApps: true category: orgs subcategory: custom-properties-for-orgs + "/organizations/{org}/settings/billing/budgets": + get: + summary: Get all budgets for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-all-budgets-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#get-all-budgets-for-an-organization + parameters: + - *61 + responses: + '200': + description: Response when getting all budgets + content: + application/json: + schema: + type: object + properties: + budgets: + type: array + items: + type: object + properties: + id: + type: string + description: The unique identifier for the budget + examples: + - 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: + type: string + description: The type of pricing for the budget + enum: + - SkuPricing + - ProductPricing + examples: + - SkuPricing + budget_amount: + type: integer + description: The budget amount limit in whole dollars. For + license-based products, this represents the number of + licenses. + prevent_further_usage: + type: boolean + description: The type of limit enforcement for the budget + examples: + - true + budget_scope: + type: string + description: The scope of the budget (enterprise, organization, + repository, cost center) + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity for the budget (enterprise + does not require a name). + examples: + - octocat/hello-world + budget_product_sku: + type: string + description: A single product or sku to apply the budget + to. + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + examples: + - mona + - lisa + required: + - will_alert + - alert_recipients + required: + - id + - budget_type + - budget_product_sku + - budget_scope + - budget_amount + - prevent_further_usage + - budget_alerting + description: Array of budget objects for the enterprise + required: + - budgets + examples: + default: + value: + budgets: + - id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_skus: + - actions + budget_scope: enterprise + budget_amount: 1000.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - enterprise-admin + - billing-manager + - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 + budget_type: SkuPricing + budget_product_skus: + - actions_linux + budget_scope: organization + budget_amount: 500.0 + prevent_further_usage: false + budget_alerting: + will_alert: true + alert_recipients: + - org-owner + - id: 6ba7b810-9dad-11d1-80b4-00c04fd430c8 + budget_type: ProductPricing + budget_product_skus: + - packages + budget_scope: cost_center + budget_amount: 250.0 + prevent_further_usage: true + budget_alerting: + will_alert: false + alert_recipients: [] + '404': *6 + '403': *27 + '500': *96 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing + "/organizations/{org}/settings/billing/budgets/{budget_id}": + get: + summary: Get a budget by ID for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a budget by ID. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#get-a-budget-by-id-for-an-organization + parameters: + - *61 + - &98 + name: budget_id + description: The ID corresponding to the budget. + in: path + required: true + schema: + type: string + responses: + '200': + description: Response when updating a budget + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + enum: + - enterprise + - organization + - repository + - cost_center + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + examples: + - octocat/hello-world + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + examples: + - true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + examples: + - actions_linux + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + examples: + - ProductPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + examples: + - mona + - lisa + required: + - id + - budget_amount + - prevent_further_usage + - budget_product_sku + - budget_type + - budget_alerting + - budget_scope + - budget_entity_name + examples: + default: + value: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa + '400': *14 + '404': *6 + '403': *27 + '500': *96 + '503': *97 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing + patch: + summary: Update a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/update-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget-for-an-organization + parameters: + - *61 + - *98 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered in the + budget + examples: + update-budget: + summary: Update budget example + value: + prevent_further_usage: false + budget_amount: 10 + budget_alerting: + will_alert: false + alert_recipients: [] + responses: + '200': + description: Budget updated successfully + content: + application/json: + schema: + type: object + properties: + message: + type: string + examples: + - Budget successfully updated. + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_amount: + type: number + format: float + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the + budget is exceeded + budget_alerting: + type: object + required: + - will_alert + - alert_recipients + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + default: '' + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered + in the budget + examples: + update-budget: + value: + message: Budget successfully updated. + id: 550e8400-e29b-41d4-a716-446655440000 + '400': *14 + '401': *23 + '403': *27 + '404': + description: Budget not found or feature not enabled + content: + application/json: + schema: *3 + examples: + budget-not-found: + value: + message: Budget with ID 550e8400-e29b-41d4-a716-446655440000 not + found. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + feature-not-enabled: + value: + message: Not Found + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + '422': *15 + '500': + description: Internal server error + content: + application/json: + schema: *3 + examples: + server-error: + value: + message: Unable to update budget. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + delete: + summary: Delete a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/delete-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#delete-a-budget-for-an-organization + parameters: + - *61 + - *98 + 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': *14 + '404': *6 + '403': *27 + '500': *96 + '503': *97 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization @@ -16768,7 +17257,7 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-an-organization parameters: - *61 - - &98 + - &99 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, @@ -16777,7 +17266,7 @@ paths: required: false schema: type: integer - - &100 + - &101 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 @@ -16786,7 +17275,7 @@ paths: required: false schema: type: integer - - &99 + - &100 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 @@ -16801,14 +17290,14 @@ paths: required: false schema: type: string - - &680 + - &679 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &101 + - &102 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -16946,8 +17435,8 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - *61 - - *98 - - &683 + - *99 + - &682 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -16956,7 +17445,7 @@ paths: required: false schema: type: integer - - *99 + - *100 responses: '200': description: Billing usage report response for an organization @@ -17040,7 +17529,7 @@ paths: subcategory: enhanced-billing "/organizations/{org}/settings/billing/usage/summary": get: - summary: Get billing usage summary report for an organization + summary: Get billing usage summary for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. @@ -17053,21 +17542,21 @@ paths: operationId: billing/get-github-billing-usage-summary-report-org externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-report-for-an-organization + url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-for-an-organization parameters: - *61 - - *98 - - *100 - *99 - - &684 + - *101 + - *100 + - &683 name: repository description: The repository name to query for usage in the format owner/repository. in: query required: false schema: type: string - - *101 - - &685 + - *102 + - &684 name: sku description: The SKU to query for usage. in: query @@ -17076,7 +17565,7 @@ paths: type: string responses: '200': - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -17210,7 +17699,7 @@ paths: description: Response content: application/json: - schema: &102 + schema: &103 title: Organization Full description: Organization Full type: object @@ -17605,7 +18094,7 @@ paths: - updated_at - archived_at examples: - default-response: &103 + default-response: &104 value: login: github id: 1 @@ -17922,17 +18411,17 @@ paths: description: Response content: application/json: - schema: *102 + schema: *103 examples: - default: *103 + default: *104 '422': description: Validation failed content: application/json: schema: oneOf: - - *104 - *105 + - *106 '409': *45 x-github: githubCloudOnly: false @@ -18046,7 +18535,7 @@ paths: type: integer repository_cache_usages: type: array - items: &322 + items: &320 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -18122,7 +18611,7 @@ paths: type: integer runners: type: array - items: &106 + items: &107 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -18185,7 +18674,7 @@ paths: - size_gb - display_name - source - machine_size_details: &114 + machine_size_details: &115 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -18294,7 +18783,7 @@ paths: - public_ip_enabled - platform examples: - default: &134 + default: &135 value: total_count: 2 runners: @@ -18432,9 +18921,9 @@ paths: description: Response content: application/json: - schema: *106 + schema: *107 examples: - default: &115 + default: &116 value: id: 5 name: My hosted ubuntu runner @@ -18491,7 +18980,7 @@ paths: type: integer images: type: array - items: &107 + items: &108 title: GitHub-hosted runner custom image details description: Provides details of a custom runner image type: object @@ -18550,7 +19039,7 @@ paths: - latest_version - state examples: - default: &109 + default: &110 value: total_count: 2 image_versions: @@ -18582,7 +19071,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners parameters: - *61 - - &108 + - &109 name: image_definition_id description: Image definition ID of custom image in: path @@ -18594,7 +19083,7 @@ paths: description: Response content: application/json: - schema: *107 + schema: *108 examples: default: value: @@ -18625,7 +19114,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization parameters: - *61 - - *108 + - *109 responses: '204': description: Response @@ -18648,7 +19137,7 @@ 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: - - *108 + - *109 - *61 responses: '200': @@ -18665,7 +19154,7 @@ paths: type: integer image_versions: type: array - items: &110 + items: &111 title: GitHub-hosted runner custom image version details. description: Provides details of a hosted runner custom image version @@ -18703,7 +19192,7 @@ paths: - created_on - state_details examples: - default: *109 + default: *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18724,8 +19213,8 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners parameters: - *61 - - *108 - - &111 + - *109 + - &112 name: version description: Version of a custom image in: path @@ -18738,7 +19227,7 @@ paths: description: Response content: application/json: - schema: *110 + schema: *111 examples: default: value: @@ -18765,8 +19254,8 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization parameters: - *61 - - *108 - - *111 + - *109 + - *112 responses: '204': description: Response @@ -18803,7 +19292,7 @@ paths: type: integer images: type: array - items: &112 + items: &113 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -18843,7 +19332,7 @@ paths: - display_name - source examples: - default: &113 + default: &114 value: id: ubuntu-20.04 platform: linux-x64 @@ -18883,9 +19372,9 @@ paths: type: integer images: type: array - items: *112 + items: *113 examples: - default: *113 + default: *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18973,7 +19462,7 @@ paths: type: integer machine_specs: type: array - items: *114 + items: *115 examples: default: value: @@ -19043,7 +19532,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - *61 - - &116 + - &117 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -19055,9 +19544,9 @@ paths: description: Response content: application/json: - schema: *106 + schema: *107 examples: - default: *115 + default: *116 headers: Link: *52 x-github: @@ -19078,7 +19567,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - *61 - - *116 + - *117 requestBody: required: true content: @@ -19122,9 +19611,9 @@ paths: description: Response content: application/json: - schema: *106 + schema: *107 examples: - default: *115 + default: *116 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -19141,15 +19630,15 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - *61 - - *116 + - *117 responses: '202': description: Response content: application/json: - schema: *106 + schema: *107 examples: - default: *115 + default: *116 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -19175,7 +19664,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &117 + schema: &118 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -19189,7 +19678,7 @@ paths: required: - include_claim_keys examples: - default: &118 + default: &119 value: include_claim_keys: - repo @@ -19216,15 +19705,15 @@ paths: required: true content: application/json: - schema: *117 + schema: *118 examples: - default: *118 + default: *119 responses: '201': description: Empty response content: application/json: - schema: &144 + schema: &145 title: Empty Object description: An object without any properties. type: object @@ -19263,7 +19752,7 @@ paths: schema: type: object properties: - enabled_repositories: &119 + enabled_repositories: &120 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -19276,7 +19765,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: &120 + allowed_actions: &121 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -19284,12 +19773,12 @@ paths: - all - local_only - selected - selected_actions_url: &328 + selected_actions_url: &326 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: &121 + sha_pinning_required: &122 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -19331,9 +19820,9 @@ paths: schema: type: object properties: - enabled_repositories: *119 - allowed_actions: *120 - sha_pinning_required: *121 + enabled_repositories: *120 + allowed_actions: *121 + sha_pinning_required: *122 required: - enabled_repositories examples: @@ -19367,7 +19856,7 @@ paths: description: Response content: application/json: - schema: &332 + schema: &330 type: object properties: days: @@ -19409,7 +19898,7 @@ paths: required: true content: application/json: - schema: &333 + schema: &331 type: object properties: days: @@ -19452,7 +19941,7 @@ paths: description: Response content: application/json: - schema: &122 + schema: &123 type: object properties: approval_policy: @@ -19466,7 +19955,7 @@ paths: required: - approval_policy examples: - default: &334 + default: &332 value: approval_policy: first_time_contributors '404': *6 @@ -19497,7 +19986,7 @@ paths: required: true content: application/json: - schema: *122 + schema: *123 examples: default: summary: Set approval policy to first time contributors @@ -19525,7 +20014,7 @@ paths: description: Response content: application/json: - schema: &335 + schema: &333 type: object required: - run_workflows_from_fork_pull_requests @@ -19551,7 +20040,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &123 + default: &124 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -19579,7 +20068,7 @@ paths: required: true content: application/json: - schema: &336 + schema: &334 type: object required: - run_workflows_from_fork_pull_requests @@ -19602,7 +20091,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *123 + default: *124 responses: '204': description: Empty response for successful settings update @@ -19652,7 +20141,7 @@ paths: type: array items: *64 examples: - default: &127 + default: &128 value: total_count: 1 repositories: @@ -19837,7 +20326,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *61 - - &124 + - &125 name: repository_id description: The unique identifier of the repository. in: path @@ -19866,7 +20355,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *61 - - *124 + - *125 responses: '204': description: Response @@ -19895,7 +20384,7 @@ paths: description: Response content: application/json: - schema: &125 + schema: &126 type: object properties: github_owned_allowed: @@ -19917,7 +20406,7 @@ paths: items: type: string examples: - default: &126 + default: &127 value: github_owned_allowed: true verified_allowed: false @@ -19950,9 +20439,9 @@ paths: required: false content: application/json: - schema: *125 + schema: *126 examples: - selected_actions: *126 + selected_actions: *127 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -20084,7 +20573,7 @@ paths: type: array items: *64 examples: - default: *127 + default: *128 '403': *27 '404': *6 x-github: @@ -20153,7 +20642,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - *61 - - *124 + - *125 responses: '204': description: No content @@ -20180,7 +20669,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization parameters: - *61 - - *124 + - *125 responses: '204': description: No content @@ -20214,17 +20703,17 @@ paths: description: Response content: application/json: - schema: &337 + schema: &335 type: object properties: - default_workflow_permissions: &128 + default_workflow_permissions: &129 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &129 + can_approve_pull_request_reviews: &130 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -20232,7 +20721,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &130 + default: &131 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -20265,13 +20754,13 @@ paths: required: false content: application/json: - schema: &338 + schema: &336 type: object properties: - default_workflow_permissions: *128 - can_approve_pull_request_reviews: *129 + default_workflow_permissions: *129 + can_approve_pull_request_reviews: *130 examples: - default: *130 + default: *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20316,7 +20805,7 @@ paths: type: number runner_groups: type: array - items: &131 + items: &132 type: object properties: id: @@ -20506,9 +20995,9 @@ paths: description: Response content: application/json: - schema: *131 + schema: *132 examples: - default: &133 + default: &134 value: id: 2 name: octo-runner-group @@ -20544,7 +21033,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - *61 - - &132 + - &133 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -20556,7 +21045,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *132 examples: default: value: @@ -20593,7 +21082,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - *61 - - *132 + - *133 requestBody: required: true content: @@ -20649,9 +21138,9 @@ paths: description: Response content: application/json: - schema: *131 + schema: *132 examples: - default: *133 + default: *134 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -20671,7 +21160,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - *61 - - *132 + - *133 responses: '204': description: Response @@ -20695,7 +21184,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - *61 - - *132 + - *133 - *17 - *19 responses: @@ -20713,9 +21202,9 @@ paths: type: number runners: type: array - items: *106 + items: *107 examples: - default: *134 + default: *135 headers: Link: *52 x-github: @@ -20738,7 +21227,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *61 - - *132 + - *133 - *19 - *17 responses: @@ -20756,9 +21245,9 @@ paths: type: number repositories: type: array - items: *135 + items: *136 examples: - default: &640 + default: &639 value: total_count: 1 repositories: @@ -21011,7 +21500,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - *61 - - *132 + - *133 requestBody: required: true content: @@ -21056,8 +21545,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *61 - - *132 - - *124 + - *133 + - *125 responses: '204': description: Response @@ -21080,8 +21569,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - *61 - - *132 - - *124 + - *133 + - *125 responses: '204': description: Response @@ -21105,7 +21594,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - *61 - - *132 + - *133 - *17 - *19 responses: @@ -21123,7 +21612,7 @@ paths: type: number runners: type: array - items: &137 + items: &138 title: Self hosted runners description: A self hosted runner type: object @@ -21157,7 +21646,7 @@ paths: type: boolean labels: type: array - items: &140 + items: &141 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -21187,7 +21676,7 @@ paths: - busy - labels examples: - default: &138 + default: &139 value: total_count: 2 runners: @@ -21247,7 +21736,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - *61 - - *132 + - *133 requestBody: required: true content: @@ -21292,8 +21781,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - *61 - - *132 - - &136 + - *133 + - &137 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -21322,8 +21811,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - *61 - - *132 - - *136 + - *133 + - *137 responses: '204': description: Response @@ -21371,9 +21860,9 @@ paths: type: integer runners: type: array - items: *137 + items: *138 examples: - default: *138 + default: *139 headers: Link: *52 x-github: @@ -21405,7 +21894,7 @@ paths: application/json: schema: type: array - items: &339 + items: &337 title: Runner Application description: Runner Application type: object @@ -21430,7 +21919,7 @@ paths: - download_url - filename examples: - default: &340 + default: &338 value: - os: osx architecture: x64 @@ -21516,7 +22005,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &341 + '201': &339 description: Response content: application/json: @@ -21526,7 +22015,7 @@ paths: - runner - encoded_jit_config properties: - runner: *137 + runner: *138 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -21589,7 +22078,7 @@ paths: description: Response content: application/json: - schema: &139 + schema: &140 title: Authentication Token description: Authentication Token type: object @@ -21631,7 +22120,7 @@ paths: - token - expires_at examples: - default: &342 + default: &340 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -21668,9 +22157,9 @@ paths: description: Response content: application/json: - schema: *139 + schema: *140 examples: - default: &343 + default: &341 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -21696,15 +22185,15 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - *61 - - *136 + - *137 responses: '200': description: Response content: application/json: - schema: *137 + schema: *138 examples: - default: &344 + default: &342 value: id: 23 name: MBP @@ -21746,7 +22235,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - *61 - - *136 + - *137 responses: '204': description: Response @@ -21773,9 +22262,9 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - *61 - - *136 + - *137 responses: - '200': &141 + '200': &142 description: Response content: application/json: @@ -21789,7 +22278,7 @@ paths: type: integer labels: type: array - items: *140 + items: *141 examples: default: value: @@ -21829,7 +22318,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - *61 - - *136 + - *137 requestBody: required: true content: @@ -21853,7 +22342,7 @@ paths: - gpu - accelerated responses: - '200': *141 + '200': *142 '404': *6 '422': *7 x-github: @@ -21878,7 +22367,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - *61 - - *136 + - *137 requestBody: required: true content: @@ -21903,7 +22392,7 @@ paths: - gpu - accelerated responses: - '200': *141 + '200': *142 '404': *6 '422': *7 x-github: @@ -21928,9 +22417,9 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - *61 - - *136 + - *137 responses: - '200': &345 + '200': &343 description: Response content: application/json: @@ -21944,7 +22433,7 @@ paths: type: integer labels: type: array - items: *140 + items: *141 examples: default: value: @@ -21986,8 +22475,8 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - *61 - - *136 - - &346 + - *137 + - &344 name: name description: The name of a self-hosted runner's custom label. in: path @@ -21995,7 +22484,7 @@ paths: schema: type: string responses: - '200': *141 + '200': *142 '404': *6 '422': *7 x-github: @@ -22038,7 +22527,7 @@ paths: type: integer secrets: type: array - items: &142 + items: &143 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -22119,7 +22608,7 @@ paths: description: Response content: application/json: - schema: &358 + schema: &356 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -22154,7 +22643,7 @@ paths: - key_id - key examples: - default: &359 + default: &357 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -22180,7 +22669,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - *61 - - &143 + - &144 name: secret_name description: The name of the secret. in: path @@ -22192,7 +22681,7 @@ paths: description: Response content: application/json: - schema: *142 + schema: *143 examples: default: value: @@ -22223,7 +22712,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - *61 - - *143 + - *144 requestBody: required: true content: @@ -22280,7 +22769,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -22307,7 +22796,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - *61 - - *143 + - *144 responses: '204': description: Response @@ -22334,7 +22823,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - *61 - - *143 + - *144 - *19 - *17 responses: @@ -22352,9 +22841,9 @@ paths: type: integer repositories: type: array - items: *135 + items: *136 examples: - default: &147 + default: &148 value: total_count: 1 repositories: @@ -22447,7 +22936,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - *61 - - *143 + - *144 requestBody: required: true content: @@ -22500,7 +22989,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - *61 - - *143 + - *144 - name: repository_id in: path required: true @@ -22534,7 +23023,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - *61 - - *143 + - *144 - name: repository_id in: path required: true @@ -22567,7 +23056,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *61 - - &327 + - &325 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)." @@ -22591,7 +23080,7 @@ paths: type: integer variables: type: array - items: &145 + items: &146 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -22729,7 +23218,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -22755,7 +23244,7 @@ paths: url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - *61 - - &146 + - &147 name: name description: The name of the variable. in: path @@ -22767,7 +23256,7 @@ paths: description: Response content: application/json: - schema: *145 + schema: *146 examples: default: value: @@ -22798,7 +23287,7 @@ paths: url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - *61 - - *146 + - *147 requestBody: required: true content: @@ -22861,7 +23350,7 @@ paths: url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - *61 - - *146 + - *147 responses: '204': description: Response @@ -22888,7 +23377,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - *61 - - *146 + - *147 - *19 - *17 responses: @@ -22906,9 +23395,9 @@ paths: type: integer repositories: type: array - items: *135 + items: *136 examples: - default: *147 + default: *148 '409': description: Response when the visibility of the variable is not set to `selected` @@ -22935,7 +23424,7 @@ paths: url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - *61 - - *146 + - *147 requestBody: required: true content: @@ -22985,7 +23474,7 @@ paths: url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - *61 - - *146 + - *147 - name: repository_id in: path required: true @@ -23020,7 +23509,7 @@ paths: url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - *61 - - *146 + - *147 - name: repository_id in: path required: true @@ -23317,12 +23806,12 @@ paths: required: - subject_digests examples: - default: &667 + default: &666 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &668 + withPredicateType: &667 value: subject_digests: - sha256:abc123 @@ -23381,7 +23870,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &669 + default: &668 value: attestations_subject_digests: - sha256:abc: @@ -23730,7 +24219,7 @@ paths: initiator: type: string examples: - default: &372 + default: &370 value: attestations: - bundle: @@ -23949,7 +24438,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &148 + schema: &149 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -23975,7 +24464,7 @@ paths: application/json: schema: type: array - items: &149 + items: &150 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -24006,7 +24495,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &169 + items: &170 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -24083,7 +24572,7 @@ paths: parent: anyOf: - type: 'null' - - &220 + - &221 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -24219,7 +24708,7 @@ paths: - string - 'null' format: date-time - state: *148 + state: *149 contact_link: description: The contact link of the campaign. type: @@ -24442,9 +24931,9 @@ paths: description: Response content: application/json: - schema: *149 + schema: *150 examples: - default: &150 + default: &151 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -24527,9 +25016,9 @@ paths: description: Response content: application/json: - schema: *149 + schema: *150 examples: - default: *150 + default: *151 '404': *6 '422': description: Unprocessable Entity @@ -24607,7 +25096,7 @@ paths: - string - 'null' format: uri - state: *148 + state: *149 examples: default: value: @@ -24617,9 +25106,9 @@ paths: description: Response content: application/json: - schema: *149 + schema: *150 examples: - default: *150 + default: *151 '400': description: Bad Request content: @@ -24686,17 +25175,17 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *61 - - &397 + - &395 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: &158 + schema: &159 type: string description: The name of the tool used to generate the code scanning analysis. - - &398 + - &396 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 @@ -24704,7 +25193,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &159 + schema: &160 type: - string - 'null' @@ -24720,7 +25209,7 @@ paths: be returned. in: query required: false - schema: &400 + schema: &398 type: string description: State of a code scanning alert. enum: @@ -24743,7 +25232,7 @@ paths: be returned. in: query required: false - schema: &401 + schema: &399 type: string description: Severity of a code scanning alert. enum: @@ -24764,18 +25253,18 @@ paths: items: type: object properties: - number: *151 - created_at: *152 - updated_at: *153 - url: *154 - html_url: *155 - instances_url: &402 + number: *152 + created_at: *153 + updated_at: *154 + url: *155 + html_url: *156 + instances_url: &400 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &160 + state: &161 type: - string - 'null' @@ -24785,13 +25274,13 @@ paths: - dismissed - fixed - - fixed_at: *156 + fixed_at: *157 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *157 - dismissed_reason: &403 + dismissed_at: *158 + dismissed_reason: &401 type: - string - 'null' @@ -24802,14 +25291,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &404 + dismissed_comment: &402 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &405 + rule: &403 type: object properties: id: @@ -24870,26 +25359,26 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &406 + tool: &404 type: object properties: - name: *158 + name: *159 version: type: - string - 'null' description: The version of the tool used to generate the code scanning analysis. - guid: *159 - most_recent_instance: &407 + guid: *160 + most_recent_instance: &405 type: object properties: - ref: &399 + ref: &397 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &417 + analysis_key: &415 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -24900,13 +25389,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &418 + category: &416 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: *160 + state: *161 commit_sha: type: string message: @@ -25412,7 +25901,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *161 + code_scanning_options: *162 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -25555,7 +26044,7 @@ paths: application/json: schema: *41 examples: - default: *162 + default: *163 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25583,9 +26072,9 @@ paths: description: Response content: application/json: - schema: *163 + schema: *164 examples: - default: *164 + default: *165 '304': *35 '403': *27 '404': *6 @@ -25637,7 +26126,7 @@ paths: - 32 - 91 responses: - '204': *165 + '204': *166 '400': *14 '403': *27 '404': *6 @@ -25672,7 +26161,7 @@ paths: application/json: schema: *41 examples: - default: *162 + default: *163 '304': *35 '403': *27 '404': *6 @@ -25956,7 +26445,7 @@ paths: - *61 - *43 responses: - '204': *165 + '204': *166 '400': *14 '403': *27 '404': *6 @@ -26094,7 +26583,7 @@ paths: default: value: default_for_new_repos: all - configuration: *162 + configuration: *163 '403': *27 '404': *6 x-github: @@ -26147,13 +26636,13 @@ paths: application/json: schema: type: array - items: *166 + items: *167 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *167 + repository: *168 '403': *27 '404': *6 x-github: @@ -26193,7 +26682,7 @@ paths: type: integer codespaces: type: array - items: &210 + items: &211 type: object title: Codespace description: A codespace. @@ -26224,11 +26713,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *135 + repository: *136 machine: anyOf: - type: 'null' - - &430 + - &428 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -26515,7 +27004,7 @@ paths: - pulls_url - recent_folders examples: - default: &211 + default: &212 value: total_count: 3 codespaces: @@ -27139,7 +27628,7 @@ paths: type: integer secrets: type: array - items: &168 + items: &169 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -27180,7 +27669,7 @@ paths: - updated_at - visibility examples: - default: &431 + default: &429 value: total_count: 2 secrets: @@ -27218,7 +27707,7 @@ paths: description: Response content: application/json: - schema: &432 + schema: &430 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -27253,7 +27742,7 @@ paths: - key_id - key examples: - default: &433 + default: &431 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -27277,15 +27766,15 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - *61 - - *143 + - *144 responses: '200': description: Response content: application/json: - schema: *168 + schema: *169 examples: - default: &435 + default: &433 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -27313,7 +27802,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - *61 - - *143 + - *144 requestBody: required: true content: @@ -27368,7 +27857,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -27395,7 +27884,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - *61 - - *143 + - *144 responses: '204': description: Response @@ -27421,7 +27910,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - *61 - - *143 + - *144 - *19 - *17 responses: @@ -27439,9 +27928,9 @@ paths: type: integer repositories: type: array - items: *135 + items: *136 examples: - default: *147 + default: *148 '404': *6 x-github: githubCloudOnly: false @@ -27464,7 +27953,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - *61 - - *143 + - *144 requestBody: required: true content: @@ -27515,7 +28004,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - *61 - - *143 + - *144 - name: repository_id in: path required: true @@ -27549,7 +28038,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - *61 - - *143 + - *144 - name: repository_id in: path required: true @@ -27752,7 +28241,7 @@ paths: currently being billed. seats: type: array - items: &213 + items: &214 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -27770,7 +28259,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *169 + - *170 - *53 type: - 'null' @@ -28728,11 +29217,11 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *61 - - *170 - *171 - *172 - *173 - *174 + - *175 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -28770,8 +29259,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *175 - *176 + - *177 - *46 - *38 - *39 @@ -28783,9 +29272,9 @@ paths: application/json: schema: type: array - items: *177 + items: *178 examples: - default: *178 + default: *179 '304': *35 '400': *14 '403': *27 @@ -28829,7 +29318,7 @@ paths: type: integer secrets: type: array - items: &179 + items: &180 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -28908,7 +29397,7 @@ paths: description: Response content: application/json: - schema: &458 + schema: &456 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -28927,7 +29416,7 @@ paths: - key_id - key examples: - default: &459 + default: &457 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -28951,13 +29440,13 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - *61 - - *143 + - *144 responses: '200': description: Response content: application/json: - schema: *179 + schema: *180 examples: default: value: @@ -28986,7 +29475,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - *61 - - *143 + - *144 requestBody: required: true content: @@ -29045,7 +29534,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -29070,7 +29559,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - *61 - - *143 + - *144 responses: '204': description: Response @@ -29095,7 +29584,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - *61 - - *143 + - *144 - *19 - *17 responses: @@ -29113,9 +29602,9 @@ paths: type: integer repositories: type: array - items: *135 + items: *136 examples: - default: *147 + default: *148 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29137,7 +29626,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - *61 - - *143 + - *144 requestBody: required: true content: @@ -29188,7 +29677,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - *61 - - *143 + - *144 - name: repository_id in: path required: true @@ -29220,7 +29709,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - *61 - - *143 + - *144 - name: repository_id in: path required: true @@ -29258,7 +29747,7 @@ paths: application/json: schema: type: array - items: &222 + items: &223 title: Package description: A software package type: object @@ -29311,7 +29800,7 @@ paths: repository: anyOf: - type: 'null' - - *135 + - *136 created_at: type: string format: date-time @@ -29329,7 +29818,7 @@ paths: - created_at - updated_at examples: - default: &223 + default: &224 value: - id: 197 name: hello_docker @@ -29499,7 +29988,7 @@ paths: application/json: schema: type: array - items: &202 + items: &203 title: Organization Invitation description: Organization Invitation type: object @@ -29553,7 +30042,7 @@ paths: - invitation_teams_url - node_id examples: - default: &203 + default: &204 value: - id: 1 login: monalisa @@ -29620,7 +30109,7 @@ paths: application/json: schema: type: array - items: &180 + items: &181 title: Org Hook description: Org Hook type: object @@ -29805,9 +30294,9 @@ paths: description: Response content: application/json: - schema: *180 + schema: *181 examples: - default: &181 + default: &182 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -29855,7 +30344,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - *61 - - &182 + - &183 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. @@ -29868,9 +30357,9 @@ paths: description: Response content: application/json: - schema: *180 + schema: *181 examples: - default: *181 + default: *182 '404': *6 x-github: githubCloudOnly: false @@ -29898,7 +30387,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - *61 - - *182 + - *183 requestBody: required: false content: @@ -29944,7 +30433,7 @@ paths: description: Response content: application/json: - schema: *180 + schema: *181 examples: default: value: @@ -29986,7 +30475,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - *61 - - *182 + - *183 responses: '204': description: Response @@ -30014,7 +30503,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *61 - - *182 + - *183 responses: '200': description: Response @@ -30045,7 +30534,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *61 - - *182 + - *183 requestBody: required: false content: @@ -30096,9 +30585,9 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *61 - - *182 - - *17 - *183 + - *17 + - *184 responses: '200': description: Response @@ -30106,9 +30595,9 @@ paths: application/json: schema: type: array - items: *184 + items: *185 examples: - default: *185 + default: *186 '400': *14 '422': *15 x-github: @@ -30134,16 +30623,16 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *61 - - *182 + - *183 - *16 responses: '200': description: Response content: application/json: - schema: *186 + schema: *187 examples: - default: *187 + default: *188 '400': *14 '422': *15 x-github: @@ -30169,7 +30658,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *61 - - *182 + - *183 - *16 responses: '202': *37 @@ -30199,7 +30688,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - *61 - - *182 + - *183 responses: '204': description: Response @@ -30222,7 +30711,7 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - *61 - - &192 + - &193 name: actor_type in: path description: The type of the actor @@ -30235,14 +30724,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &193 + - &194 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &188 + - &189 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`.' @@ -30250,7 +30739,7 @@ paths: required: true schema: type: string - - &189 + - &190 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) @@ -30345,12 +30834,12 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - *61 - - *188 - *189 + - *190 - *19 - *17 - *46 - - &198 + - &199 name: sort description: The property to sort the results by. in: query @@ -30430,14 +30919,14 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - *61 - - *188 - *189 + - *190 responses: '200': description: Response content: application/json: - schema: &190 + schema: &191 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -30453,7 +30942,7 @@ paths: type: integer format: int64 examples: - default: &191 + default: &192 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -30474,23 +30963,23 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - *61 - - &194 + - &195 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *188 - *189 + - *190 responses: '200': description: Response content: application/json: - schema: *190 + schema: *191 examples: - default: *191 + default: *192 x-github: enabledForGitHubApps: true category: orgs @@ -30509,18 +30998,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *61 - - *188 - *189 - - *192 + - *190 - *193 + - *194 responses: '200': description: Response content: application/json: - schema: *190 + schema: *191 examples: - default: *191 + default: *192 x-github: enabledForGitHubApps: true category: orgs @@ -30538,9 +31027,9 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - *61 - - *188 - *189 - - &195 + - *190 + - &196 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -30553,7 +31042,7 @@ paths: description: Response content: application/json: - schema: &196 + schema: &197 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -30569,7 +31058,7 @@ paths: type: integer format: int64 examples: - default: &197 + default: &198 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -30606,18 +31095,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - *61 - - *194 - - *188 - - *189 - *195 + - *189 + - *190 + - *196 responses: '200': description: Response content: application/json: - schema: *196 + schema: *197 examples: - default: *197 + default: *198 x-github: enabledForGitHubApps: true category: orgs @@ -30635,19 +31124,19 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - *61 - - *192 - *193 - - *188 + - *194 - *189 - - *195 + - *190 + - *196 responses: '200': description: Response content: application/json: - schema: *196 + schema: *197 examples: - default: *197 + default: *198 x-github: enabledForGitHubApps: true category: orgs @@ -30665,13 +31154,13 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - *61 - - *194 - - *188 + - *195 - *189 + - *190 - *19 - *17 - *46 - - *198 + - *199 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -30755,7 +31244,7 @@ paths: application/json: schema: *20 examples: - default: &497 + default: &495 value: id: 1 account: @@ -30921,12 +31410,12 @@ paths: application/json: schema: anyOf: - - &200 + - &201 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &199 + limit: &200 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -30954,7 +31443,7 @@ paths: properties: {} additionalProperties: false examples: - default: &201 + default: &202 value: limit: collaborators_only origin: organization @@ -30983,13 +31472,13 @@ paths: required: true content: application/json: - schema: &498 + schema: &496 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *199 + limit: *200 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -31014,9 +31503,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *201 examples: - default: *201 + default: *202 '422': *15 x-github: githubCloudOnly: false @@ -31092,9 +31581,9 @@ paths: application/json: schema: type: array - items: *202 + items: *203 examples: - default: *203 + default: *204 headers: Link: *52 '404': *6 @@ -31171,7 +31660,7 @@ paths: description: Response content: application/json: - schema: *202 + schema: *203 examples: default: value: @@ -31226,7 +31715,7 @@ paths: url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - *61 - - &204 + - &205 name: invitation_id description: The unique identifier of the invitation. in: path @@ -31257,7 +31746,7 @@ paths: url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - *61 - - *204 + - *205 - *17 - *19 responses: @@ -31267,9 +31756,9 @@ paths: application/json: schema: type: array - items: *169 + items: *170 examples: - default: &221 + default: &222 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -31312,7 +31801,7 @@ paths: application/json: schema: type: array - items: *205 + items: *206 examples: default: value: @@ -31400,9 +31889,9 @@ paths: description: Response content: application/json: - schema: *205 + schema: *206 examples: - default: &206 + default: &207 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -31435,7 +31924,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *61 - - &207 + - &208 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -31491,9 +31980,9 @@ paths: description: Response content: application/json: - schema: *205 + schema: *206 examples: - default: *206 + default: *207 '404': *6 '422': *7 x-github: @@ -31518,7 +32007,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *61 - - *207 + - *208 responses: '204': description: Response @@ -31581,7 +32070,7 @@ paths: - closed - all default: open - - *208 + - *209 - name: type description: Can be the name of an issue type. in: query @@ -31612,7 +32101,7 @@ paths: type: array items: *78 examples: - default: *209 + default: *210 headers: Link: *52 '404': *6 @@ -31771,9 +32260,9 @@ paths: type: integer codespaces: type: array - items: *210 + items: *211 examples: - default: *211 + default: *212 '304': *35 '500': *96 '401': *23 @@ -31800,7 +32289,7 @@ paths: parameters: - *61 - *57 - - &212 + - &213 name: codespace_name in: path required: true @@ -31835,15 +32324,15 @@ paths: parameters: - *61 - *57 - - *212 + - *213 responses: '200': description: Response content: application/json: - schema: *210 + schema: *211 examples: - default: &429 + default: &427 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -32023,7 +32512,7 @@ paths: description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *213 + schema: *214 examples: default: value: @@ -32099,7 +32588,7 @@ paths: description: Response content: application/json: - schema: &214 + schema: &215 title: Org Membership description: Org Membership type: object @@ -32168,7 +32657,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &215 + response-if-user-has-an-active-admin-membership-with-organization: &216 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -32265,9 +32754,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *215 examples: - response-if-user-already-had-membership-with-organization: *215 + response-if-user-already-had-membership-with-organization: *216 '422': *15 '403': *27 x-github: @@ -32339,7 +32828,7 @@ paths: application/json: schema: type: array - items: &216 + items: &217 title: Migration description: A migration. type: object @@ -32677,7 +33166,7 @@ paths: description: Response content: application/json: - schema: *216 + schema: *217 examples: default: value: @@ -32856,7 +33345,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - *61 - - &217 + - &218 name: migration_id description: The unique identifier of the migration. in: path @@ -32884,7 +33373,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *216 + schema: *217 examples: default: value: @@ -33054,7 +33543,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - *61 - - *217 + - *218 responses: '302': description: Response @@ -33076,7 +33565,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *61 - - *217 + - *218 responses: '204': description: Response @@ -33100,8 +33589,8 @@ paths: url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - *61 - - *217 - - &652 + - *218 + - &651 name: repo_name description: repo_name parameter in: path @@ -33129,7 +33618,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *61 - - *217 + - *218 - *17 - *19 responses: @@ -33139,9 +33628,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: &228 + default: &229 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -33294,7 +33783,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &219 + items: &220 title: Organization Role description: Organization roles type: object @@ -33471,7 +33960,7 @@ paths: parameters: - *61 - *62 - - &218 + - &219 name: role_id description: The unique identifier of the role. in: path @@ -33508,7 +33997,7 @@ paths: parameters: - *61 - *62 - - *218 + - *219 responses: '204': description: Response @@ -33561,7 +34050,7 @@ paths: parameters: - *61 - *57 - - *218 + - *219 responses: '204': description: Response @@ -33593,7 +34082,7 @@ paths: parameters: - *61 - *57 - - *218 + - *219 responses: '204': description: Response @@ -33622,13 +34111,13 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - *61 - - *218 + - *219 responses: '200': description: Response content: application/json: - schema: *219 + schema: *220 examples: default: value: @@ -33679,7 +34168,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - *61 - - *218 + - *219 - *17 - *19 responses: @@ -33758,7 +34247,7 @@ paths: parent: anyOf: - type: 'null' - - *220 + - *221 type: description: The ownership type of the team type: string @@ -33791,7 +34280,7 @@ paths: - type - parent examples: - default: *221 + default: *222 headers: Link: *52 '404': @@ -33821,7 +34310,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - *61 - - *218 + - *219 - *17 - *19 responses: @@ -33850,7 +34339,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *220 + items: *221 name: type: - string @@ -34160,7 +34649,7 @@ paths: - nuget - container - *61 - - &653 + - &652 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -34196,12 +34685,12 @@ paths: application/json: schema: type: array - items: *222 + items: *223 examples: - default: *223 + default: *224 '403': *27 '401': *23 - '400': &655 + '400': &654 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -34223,7 +34712,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &224 + - &225 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 @@ -34241,7 +34730,7 @@ paths: - docker - nuget - container - - &225 + - &226 name: package_name description: The name of the package. in: path @@ -34254,7 +34743,7 @@ paths: description: Response content: application/json: - schema: *222 + schema: *223 examples: default: value: @@ -34306,8 +34795,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *224 - *225 + - *226 - *61 responses: '204': @@ -34340,8 +34829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *224 - *225 + - *226 - *61 - name: token description: package token @@ -34374,8 +34863,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *224 - *225 + - *226 - *61 - *19 - *17 @@ -34396,7 +34885,7 @@ paths: application/json: schema: type: array - items: &226 + items: &227 title: Package Version description: A version of a software package type: object @@ -34531,10 +35020,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *224 - *225 + - *226 - *61 - - &227 + - &228 name: package_version_id description: Unique identifier of the package version. in: path @@ -34546,7 +35035,7 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: default: value: @@ -34582,10 +35071,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *224 - *225 + - *226 - *61 - - *227 + - *228 responses: '204': description: Response @@ -34617,10 +35106,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *224 - *225 + - *226 - *61 - - *227 + - *228 responses: '204': description: Response @@ -34650,7 +35139,7 @@ paths: - *61 - *17 - *19 - - &229 + - &230 name: sort description: The property by which to sort the results. in: query @@ -34661,7 +35150,7 @@ paths: - created_at default: created_at - *46 - - &230 + - &231 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -34673,7 +35162,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &231 + - &232 name: repository description: The name of the repository to use to filter the results. in: query @@ -34682,7 +35171,7 @@ paths: type: string examples: - Hello-World - - &232 + - &233 name: permission description: The permission to use to filter the results. in: query @@ -34691,7 +35180,7 @@ paths: type: string examples: - issues_read - - &233 + - &234 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) @@ -34701,7 +35190,7 @@ paths: schema: type: string format: date-time - - &234 + - &235 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) @@ -34711,7 +35200,7 @@ paths: schema: type: string format: date-time - - &235 + - &236 name: token_id description: The ID of the token in: query @@ -34987,7 +35476,7 @@ paths: '422': *15 '404': *6 '403': *27 - '204': *165 + '204': *166 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35028,9 +35517,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: *228 + default: *229 headers: Link: *52 x-github: @@ -35056,14 +35545,14 @@ paths: - *61 - *17 - *19 - - *229 - - *46 - *230 + - *46 - *231 - *232 - *233 - *234 - *235 + - *236 responses: '500': *96 '422': *15 @@ -35304,7 +35793,7 @@ paths: responses: '500': *96 '404': *6 - '204': *165 + '204': *166 '403': *27 '422': *15 x-github: @@ -35345,9 +35834,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: *228 + default: *229 headers: Link: *52 x-github: @@ -35389,7 +35878,7 @@ paths: type: integer configurations: type: array - items: &236 + items: &237 title: Organization private registry description: Private registry configuration for an organization type: object @@ -35685,7 +36174,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &237 + org-private-registry-with-selected-visibility: &238 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -35777,15 +36266,15 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - *61 - - *143 + - *144 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *236 + schema: *237 examples: - default: *237 + default: *238 '404': *6 x-github: githubCloudOnly: false @@ -35807,7 +36296,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - *61 - - *143 + - *144 requestBody: required: true content: @@ -35913,7 +36402,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - *61 - - *143 + - *144 responses: '204': description: Response @@ -35924,275 +36413,6 @@ paths: enabledForGitHubApps: true category: private-registries subcategory: organization-configurations - "/orgs/{org}/projects": - get: - summary: List organization 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: - - projects-classic - operationId: projects-classic/list-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#list-organization-projects - parameters: - - *61 - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &238 - title: Project - description: Projects are a way to organize columns and cards of - work. - type: object - properties: - owner_url: - type: string - format: uri - examples: - - https://api.github.com/repos/api-playground/projects-test - url: - type: string - format: uri - examples: - - https://api.github.com/projects/1002604 - html_url: - type: string - format: uri - examples: - - https://github.com/api-playground/projects-test/projects/12 - columns_url: - type: string - format: uri - examples: - - https://api.github.com/projects/1002604/columns - id: - type: integer - examples: - - 1002604 - node_id: - type: string - examples: - - MDc6UHJvamVjdDEwMDI2MDQ= - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - number: - type: integer - examples: - - 1 - state: - description: State of the project; either 'open' or 'closed' - type: string - examples: - - open - creator: - anyOf: - - type: 'null' - - *4 - created_at: - type: string - format: date-time - examples: - - '2011-04-10T20:09:31Z' - updated_at: - type: string - format: date-time - examples: - - '2014-03-03T18:58:10Z' - organization_permission: - description: The baseline permission that all organization members - have on this project. Only present if owner is an organization. - type: string - enum: - - read - - write - - admin - - none - private: - description: Whether or not this project can be seen by everyone. - Only present if owner is an organization. - type: boolean - required: - - id - - node_id - - number - - name - - body - - state - - url - - html_url - - owner_url - - creator - - columns_url - - created_at - - updated_at - 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: true - headers: - Link: *52 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create an organization 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: - - projects-classic - operationId: projects-classic/create-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#create-an-organization-project - parameters: - - *61 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the project. - body: - type: string - description: The description of the project. - required: - - name - examples: - default: - value: - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - responses: - '201': - description: Response - content: - application/json: - schema: *238 - 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' - '401': *23 - '403': *27 - '404': *6 - '410': &314 - description: Gone - content: - application/json: - schema: *3 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/orgs/{org}/projectsV2": get: summary: List projects for organization @@ -36296,7 +36516,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &733 + - &732 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -36683,7 +36903,7 @@ paths: - updated_at - project_url examples: - default: &672 + default: &671 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -36787,7 +37007,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *241 - - &673 + - &672 name: field_id description: The unique identifier of the field. in: path @@ -36802,7 +37022,7 @@ paths: application/json: schema: *242 examples: - default: &674 + default: &673 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -37685,7 +37905,7 @@ paths: description: Response content: application/json: - schema: &675 + schema: &674 title: Projects v2 Item description: An item belonging to a project type: object @@ -37699,7 +37919,7 @@ paths: content: oneOf: - *78 - - &442 + - &440 title: Pull Request Simple description: Pull Request Simple type: object @@ -37874,7 +38094,7 @@ paths: type: - array - 'null' - items: *169 + items: *170 head: type: object properties: @@ -37944,7 +38164,7 @@ paths: - review_comment - self author_association: *65 - auto_merge: &542 + auto_merge: &541 title: Auto merge description: The status of auto merging a pull request. type: @@ -38688,7 +38908,7 @@ paths: - *61 - *252 responses: - '204': *165 + '204': *166 '403': *27 '404': *6 x-github: @@ -39009,9 +39229,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: *228 + default: *229 headers: Link: *52 x-github: @@ -39214,7 +39434,7 @@ paths: description: Response content: application/json: - schema: &316 + schema: &314 title: Full Repository description: Full Repository type: object @@ -39679,7 +39899,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &447 + code_of_conduct: &445 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -39793,7 +40013,7 @@ paths: - network_count - subscribers_count examples: - default: &318 + default: &316 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -40314,7 +40534,7 @@ paths: - *61 - *17 - *19 - - &565 + - &564 name: targets description: | A comma-separated list of rule targets to filter by. @@ -40600,7 +40820,7 @@ paths: - object rules: type: array - items: &566 + items: &565 title: Repository Rule type: object description: A repository rule. @@ -40662,7 +40882,7 @@ paths: type: string enum: - required_linear_history - - &563 + - &562 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -41286,7 +41506,7 @@ paths: - tool required: - code_scanning_tools - - &564 + - &563 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -41512,7 +41732,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *61 - - &567 + - &566 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -41527,7 +41747,7 @@ paths: in: query schema: type: string - - &568 + - &567 name: time_period description: |- The time period to filter by. @@ -41543,14 +41763,14 @@ paths: - week - month default: day - - &569 + - &568 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &570 + - &569 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -41570,7 +41790,7 @@ paths: description: Response content: application/json: - schema: &571 + schema: &570 title: Rule Suites description: Response type: array @@ -41626,7 +41846,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &572 + default: &571 value: - id: 21 actor_id: 12 @@ -41670,7 +41890,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *61 - - &573 + - &572 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -41686,7 +41906,7 @@ paths: description: Response content: application/json: - schema: &574 + schema: &573 title: Rule Suite description: Response type: object @@ -41793,7 +42013,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &575 + default: &574 value: id: 21 actor_id: 12 @@ -42039,7 +42259,7 @@ paths: type: string format: date-time examples: - default: &577 + default: &576 value: - version_id: 3 actor: @@ -42092,7 +42312,7 @@ paths: description: Response content: application/json: - schema: &578 + schema: &577 allOf: - *283 - type: object @@ -42164,7 +42384,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *61 - - &579 + - &578 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -42175,7 +42395,7 @@ paths: enum: - open - resolved - - &580 + - &579 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -42185,7 +42405,7 @@ paths: required: false schema: type: string - - &581 + - &580 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -42194,7 +42414,7 @@ paths: required: false schema: type: string - - &582 + - &581 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -42209,7 +42429,7 @@ paths: - *46 - *19 - *17 - - &583 + - &582 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -42219,7 +42439,7 @@ paths: required: false schema: type: string - - &584 + - &583 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -42229,7 +42449,7 @@ paths: required: false schema: type: string - - &585 + - &584 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -42238,7 +42458,7 @@ paths: required: false schema: type: string - - &586 + - &585 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -42247,7 +42467,7 @@ paths: schema: type: boolean default: false - - &587 + - &586 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -42256,7 +42476,7 @@ paths: schema: type: boolean default: false - - &588 + - &587 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -42275,27 +42495,27 @@ paths: items: type: object properties: - number: *151 - created_at: *152 + number: *152 + created_at: *153 updated_at: anyOf: - type: 'null' - - *153 - url: *154 - html_url: *155 + - *154 + url: *155 + html_url: *156 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &589 + state: &588 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &590 + resolution: &589 type: - string - 'null' @@ -42402,14 +42622,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &591 + - &590 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &593 + - &592 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -42466,7 +42686,7 @@ paths: - blob_url - commit_sha - commit_url - - &594 + - &593 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -42527,7 +42747,7 @@ paths: - page_url - commit_sha - commit_url - - &595 + - &594 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -42542,7 +42762,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &596 + - &595 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -42557,7 +42777,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &597 + - &596 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -42572,7 +42792,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &598 + - &597 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -42587,7 +42807,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &599 + - &598 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -42602,7 +42822,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &600 + - &599 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -42617,7 +42837,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &601 + - &600 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -42632,7 +42852,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &602 + - &601 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -42647,7 +42867,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &603 + - &602 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -42662,7 +42882,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &604 + - &603 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -42677,7 +42897,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &605 + - &604 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull @@ -43177,7 +43397,7 @@ paths: application/json: schema: type: array - items: &609 + items: &608 description: A repository security advisory. type: object properties: @@ -43458,7 +43678,7 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *169 + items: *170 private_fork: readOnly: true description: A temporary private fork of the advisory's repository @@ -43496,7 +43716,7 @@ paths: - private_fork additionalProperties: false examples: - default: &610 + default: &609 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -43883,9 +44103,9 @@ paths: application/json: schema: type: array - items: *220 + items: *221 examples: - default: *221 + default: *222 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43970,7 +44190,7 @@ paths: description: Response content: application/json: - schema: &676 + schema: &675 type: object properties: total_minutes_used: @@ -44040,7 +44260,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &677 + default: &676 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -44076,7 +44296,7 @@ paths: description: Response content: application/json: - schema: &678 + schema: &677 type: object properties: total_gigabytes_bandwidth_used: @@ -44094,7 +44314,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &679 + default: &678 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -44126,7 +44346,7 @@ paths: description: Response content: application/json: - schema: &681 + schema: &680 type: object properties: days_left_in_billing_cycle: @@ -44144,7 +44364,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &682 + default: &681 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -44294,9 +44514,9 @@ paths: type: integer repositories: type: array - items: *135 + items: *136 examples: - default: *147 + default: *148 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44365,7 +44585,7 @@ paths: url: https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *61 - - *124 + - *125 responses: '204': description: Response @@ -44388,7 +44608,7 @@ paths: url: https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *61 - - *124 + - *125 responses: '204': description: Response @@ -44861,9 +45081,9 @@ paths: application/json: schema: type: array - items: *169 + items: *170 examples: - default: *221 + default: *222 headers: Link: *52 '403': *27 @@ -45031,7 +45251,7 @@ paths: parent: anyOf: - type: 'null' - - *220 + - *221 members_count: type: integer examples: @@ -45710,7 +45930,7 @@ paths: - updated_at - url examples: - default: &627 + default: &626 value: - author: login: octocat @@ -45958,7 +46178,7 @@ paths: application/json: schema: *295 examples: - default: &628 + default: &627 value: author: login: octocat @@ -46149,7 +46369,7 @@ paths: - updated_at - url examples: - default: &629 + default: &628 value: - author: login: octocat @@ -46375,7 +46595,7 @@ paths: application/json: schema: *298 examples: - default: &630 + default: &629 value: author: login: octocat @@ -46879,9 +47099,9 @@ paths: application/json: schema: type: array - items: *202 + items: *203 examples: - default: *203 + default: *204 headers: Link: *52 x-github: @@ -46993,7 +47213,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &631 + response-if-user-is-a-team-maintainer: &630 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -47058,7 +47278,7 @@ paths: application/json: schema: *305 examples: - response-if-users-membership-with-team-is-now-pending: &632 + response-if-users-membership-with-team-is-now-pending: &631 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -47200,7 +47420,7 @@ paths: - updated_at - permissions examples: - default: &633 + default: &632 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -47279,7 +47499,7 @@ paths: application/json: schema: *306 examples: - default: &634 + default: &633 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -47450,9 +47670,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: *228 + default: *229 headers: Link: *52 x-github: @@ -47490,7 +47710,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &635 + schema: &634 title: Team Repository description: A team's access to a repository. type: object @@ -48217,9 +48437,9 @@ paths: application/json: schema: type: array - items: *169 + items: *170 examples: - response-if-child-teams-exist: &636 + response-if-child-teams-exist: &635 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -48575,211 +48795,6 @@ paths: deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true - "/projects/{project_id}": - get: - summary: Get 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: - - projects-classic - operationId: projects-classic/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#get-a-project - parameters: - - *307 - responses: - '200': - description: Response - content: - application/json: - schema: *238 - examples: - default: &313 - value: - owner_url: https://api.github.com/repos/api-playground/projects-test - url: https://api.github.com/projects/1002604 - html_url: https://github.com/api-playground/projects-test/projects/1 - columns_url: https://api.github.com/projects/1002604/columns - id: 1002604 - node_id: MDc6UHJvamVjdDEwMDI2MDQ= - name: Projects Documentation - body: Developer documentation project for the developer site. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - '304': *35 - '403': *27 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update 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. - operationId: projects-classic/update - tags: - - projects-classic - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#update-a-project - parameters: - - *307 - requestBody: - required: false - content: - application/json: - schema: - properties: - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - state: - description: State of the project; either 'open' or 'closed' - type: string - examples: - - open - organization_permission: - description: The baseline permission that all organization members - have on this project - type: string - enum: - - read - - write - - admin - - none - private: - description: Whether or not this project can be seen by everyone. - type: boolean - type: object - examples: - default: - summary: Change the name, state, and permissions for a project - value: - name: Week One Sprint - state: open - organization_permission: write - responses: - '200': - description: Response - content: - application/json: - schema: *238 - examples: - default: *313 - '404': - description: Not Found if the authenticated user does not have access to - the project - '304': *35 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *23 - '410': *314 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete 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. - operationId: projects-classic/delete - tags: - - projects-classic - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#delete-a-project - parameters: - - *307 - responses: - '204': - description: Delete Success - '304': *35 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *23 - '410': *314 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/projects/{project_id}/collaborators": get: summary: List project collaborators @@ -49036,7 +49051,7 @@ paths: resources: type: object properties: - core: &315 + core: &313 title: Rate Limit type: object properties: @@ -49053,21 +49068,21 @@ paths: - remaining - reset - used - graphql: *315 - search: *315 - code_search: *315 - source_import: *315 - integration_manifest: *315 - code_scanning_upload: *315 - actions_runner_registration: *315 - scim: *315 - dependency_snapshots: *315 - dependency_sbom: *315 - code_scanning_autofix: *315 + graphql: *313 + search: *313 + code_search: *313 + source_import: *313 + integration_manifest: *313 + code_scanning_upload: *313 + actions_runner_registration: *313 + scim: *313 + dependency_snapshots: *313 + dependency_sbom: *313 + code_scanning_autofix: *313 required: - core - search - rate: *315 + rate: *313 required: - rate - resources @@ -49179,7 +49194,7 @@ paths: description: Response content: application/json: - schema: *316 + schema: *314 examples: default-response: summary: Default response @@ -49680,7 +49695,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *317 + '301': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49947,10 +49962,10 @@ paths: description: Response content: application/json: - schema: *316 + schema: *314 examples: - default: *318 - '307': &319 + default: *316 + '307': &317 description: Temporary Redirect content: application/json: @@ -50002,7 +50017,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *319 + '307': *317 '404': *6 '409': *45 x-github: @@ -50030,7 +50045,7 @@ paths: - *309 - *17 - *19 - - &350 + - &348 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -50053,7 +50068,7 @@ paths: type: integer artifacts: type: array - items: &320 + items: &318 title: Artifact description: An artifact type: object @@ -50148,7 +50163,7 @@ paths: - expires_at - updated_at examples: - default: &351 + default: &349 value: total_count: 2 artifacts: @@ -50211,7 +50226,7 @@ paths: parameters: - *308 - *309 - - &321 + - &319 name: artifact_id description: The unique identifier of the artifact. in: path @@ -50223,7 +50238,7 @@ paths: description: Response content: application/json: - schema: *320 + schema: *318 examples: default: value: @@ -50263,7 +50278,7 @@ paths: parameters: - *308 - *309 - - *321 + - *319 responses: '204': description: Response @@ -50289,7 +50304,7 @@ paths: parameters: - *308 - *309 - - *321 + - *319 - name: archive_format in: path required: true @@ -50303,7 +50318,11 @@ 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': *314 + '410': &499 + description: Gone + content: + application/json: + schema: *3 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50333,7 +50352,7 @@ paths: description: Response content: application/json: - schema: *322 + schema: *320 examples: default: value: @@ -50363,7 +50382,7 @@ paths: - *309 - *17 - *19 - - &323 + - &321 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 @@ -50397,7 +50416,7 @@ paths: description: Response content: application/json: - schema: &324 + schema: &322 title: Repository actions caches description: Repository actions caches type: object @@ -50447,7 +50466,7 @@ paths: - total_count - actions_caches examples: - default: &325 + default: &323 value: total_count: 1 actions_caches: @@ -50487,15 +50506,15 @@ paths: required: true schema: type: string - - *323 + - *321 responses: '200': description: Response content: application/json: - schema: *324 + schema: *322 examples: - default: *325 + default: *323 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50549,7 +50568,7 @@ paths: parameters: - *308 - *309 - - &326 + - &324 name: job_id description: The unique identifier of the job. in: path @@ -50561,7 +50580,7 @@ paths: description: Response content: application/json: - schema: &354 + schema: &352 title: Job description: Information of a job execution in a workflow run type: object @@ -50910,7 +50929,7 @@ paths: parameters: - *308 - *309 - - *326 + - *324 responses: '302': description: Response @@ -50940,7 +50959,7 @@ paths: parameters: - *308 - *309 - - *326 + - *324 requestBody: required: false content: @@ -50962,7 +50981,7 @@ paths: description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -51072,7 +51091,7 @@ paths: description: Empty response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -51120,7 +51139,7 @@ paths: type: integer secrets: type: array - items: &356 + items: &354 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -51141,7 +51160,7 @@ paths: - created_at - updated_at examples: - default: &357 + default: &355 value: total_count: 2 secrets: @@ -51176,7 +51195,7 @@ paths: parameters: - *308 - *309 - - *327 + - *325 - *19 responses: '200': @@ -51193,7 +51212,7 @@ paths: type: integer variables: type: array - items: &360 + items: &358 title: Actions Variable type: object properties: @@ -51227,7 +51246,7 @@ paths: - created_at - updated_at examples: - default: &361 + default: &359 value: total_count: 2 variables: @@ -51270,12 +51289,12 @@ paths: schema: type: object properties: - enabled: &329 + enabled: &327 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *120 - selected_actions_url: *328 - sha_pinning_required: *121 + allowed_actions: *121 + selected_actions_url: *326 + sha_pinning_required: *122 required: - enabled examples: @@ -51315,9 +51334,9 @@ paths: schema: type: object properties: - enabled: *329 - allowed_actions: *120 - sha_pinning_required: *121 + enabled: *327 + allowed_actions: *121 + sha_pinning_required: *122 required: - enabled examples: @@ -51354,7 +51373,7 @@ paths: description: Response content: application/json: - schema: &330 + schema: &328 type: object properties: access_level: @@ -51371,7 +51390,7 @@ paths: required: - access_level examples: - default: &331 + default: &329 value: access_level: organization x-github: @@ -51401,9 +51420,9 @@ paths: required: true content: application/json: - schema: *330 + schema: *328 examples: - default: *331 + default: *329 responses: '204': description: Response @@ -51434,7 +51453,7 @@ paths: description: Response content: application/json: - schema: *332 + schema: *330 examples: default: value: @@ -51469,7 +51488,7 @@ paths: required: true content: application/json: - schema: *333 + schema: *331 examples: default: summary: Set retention days @@ -51500,9 +51519,9 @@ paths: description: Response content: application/json: - schema: *122 + schema: *123 examples: - default: *334 + default: *332 '404': *6 x-github: enabledForGitHubApps: true @@ -51532,7 +51551,7 @@ paths: required: true content: application/json: - schema: *122 + schema: *123 examples: default: summary: Set approval policy to first time contributors @@ -51563,9 +51582,9 @@ paths: description: Response content: application/json: - schema: *335 + schema: *333 examples: - default: *123 + default: *124 '403': *27 '404': *6 x-github: @@ -51591,9 +51610,9 @@ paths: required: true content: application/json: - schema: *336 + schema: *334 examples: - default: *123 + default: *124 responses: '204': description: Empty response for successful settings update @@ -51624,9 +51643,9 @@ paths: description: Response content: application/json: - schema: *125 + schema: *126 examples: - default: *126 + default: *127 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -51654,9 +51673,9 @@ paths: required: false content: application/json: - schema: *125 + schema: *126 examples: - selected_actions: *126 + selected_actions: *127 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -51685,9 +51704,9 @@ paths: description: Response content: application/json: - schema: *337 + schema: *335 examples: - default: *130 + default: *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51720,9 +51739,9 @@ paths: required: true content: application/json: - schema: *338 + schema: *336 examples: - default: *130 + default: *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51768,9 +51787,9 @@ paths: type: integer runners: type: array - items: *137 + items: *138 examples: - default: *138 + default: *139 headers: Link: *52 x-github: @@ -51803,9 +51822,9 @@ paths: application/json: schema: type: array - items: *339 + items: *337 examples: - default: *340 + default: *338 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51871,7 +51890,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *341 + '201': *339 '404': *6 '422': *7 '409': *45 @@ -51909,9 +51928,9 @@ paths: description: Response content: application/json: - schema: *139 + schema: *140 examples: - default: *342 + default: *340 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51946,9 +51965,9 @@ paths: description: Response content: application/json: - schema: *139 + schema: *140 examples: - default: *343 + default: *341 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51972,15 +51991,15 @@ paths: parameters: - *308 - *309 - - *136 + - *137 responses: '200': description: Response content: application/json: - schema: *137 + schema: *138 examples: - default: *344 + default: *342 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52003,7 +52022,7 @@ paths: parameters: - *308 - *309 - - *136 + - *137 responses: '204': description: Response @@ -52031,9 +52050,9 @@ paths: parameters: - *308 - *309 - - *136 + - *137 responses: - '200': *141 + '200': *142 '404': *6 x-github: githubCloudOnly: false @@ -52057,7 +52076,7 @@ paths: parameters: - *308 - *309 - - *136 + - *137 requestBody: required: true content: @@ -52081,7 +52100,7 @@ paths: - gpu - accelerated responses: - '200': *141 + '200': *142 '404': *6 '422': *7 x-github: @@ -52107,7 +52126,7 @@ paths: parameters: - *308 - *309 - - *136 + - *137 requestBody: required: true content: @@ -52132,7 +52151,7 @@ paths: - gpu - accelerated responses: - '200': *141 + '200': *142 '404': *6 '422': *7 x-github: @@ -52158,9 +52177,9 @@ paths: parameters: - *308 - *309 - - *136 + - *137 responses: - '200': *345 + '200': *343 '404': *6 x-github: githubCloudOnly: false @@ -52189,10 +52208,10 @@ paths: parameters: - *308 - *309 - - *136 - - *346 + - *137 + - *344 responses: - '200': *141 + '200': *142 '404': *6 '422': *7 x-github: @@ -52220,7 +52239,7 @@ paths: parameters: - *308 - *309 - - &364 + - &362 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. @@ -52228,7 +52247,7 @@ paths: required: false schema: type: string - - &365 + - &363 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -52236,7 +52255,7 @@ paths: required: false schema: type: string - - &366 + - &364 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -52245,7 +52264,7 @@ paths: required: false schema: type: string - - &367 + - &365 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 @@ -52272,7 +52291,7 @@ paths: - pending - *17 - *19 - - &368 + - &366 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)." @@ -52281,7 +52300,7 @@ paths: schema: type: string format: date-time - - &347 + - &345 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -52290,13 +52309,13 @@ paths: schema: type: boolean default: false - - &369 + - &367 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &370 + - &368 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -52319,7 +52338,7 @@ paths: type: integer workflow_runs: type: array - items: &348 + items: &346 title: Workflow Run description: An invocation of a workflow type: object @@ -52436,7 +52455,7 @@ paths: type: - array - 'null' - items: &389 + items: &387 title: Pull Request Minimal type: object properties: @@ -52563,7 +52582,7 @@ paths: head_commit: anyOf: - type: 'null' - - &393 + - &391 title: Simple Commit description: A commit. type: object @@ -52637,8 +52656,8 @@ paths: - timestamp - author - committer - repository: *135 - head_repository: *135 + repository: *136 + head_repository: *136 head_repository_id: type: integer examples: @@ -52678,7 +52697,7 @@ paths: - workflow_url - pull_requests examples: - default: &371 + default: &369 value: total_count: 1 workflow_runs: @@ -52916,22 +52935,22 @@ paths: parameters: - *308 - *309 - - &349 + - &347 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *347 + - *345 responses: '200': description: Response content: application/json: - schema: *348 + schema: *346 examples: - default: &352 + default: &350 value: id: 30433642 name: Build @@ -53174,7 +53193,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 responses: '204': description: Response @@ -53199,7 +53218,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 responses: '200': description: Response @@ -53329,13 +53348,13 @@ paths: parameters: - *308 - *309 - - *349 + - *347 responses: '201': description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -53364,10 +53383,10 @@ paths: parameters: - *308 - *309 - - *349 + - *347 - *17 - *19 - - *350 + - *348 responses: '200': description: Response @@ -53383,9 +53402,9 @@ paths: type: integer artifacts: type: array - items: *320 + items: *318 examples: - default: *351 + default: *349 headers: Link: *52 x-github: @@ -53411,23 +53430,23 @@ paths: parameters: - *308 - *309 - - *349 - - &353 + - *347 + - &351 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *347 + - *345 responses: '200': description: Response content: application/json: - schema: *348 + schema: *346 examples: - default: *352 + default: *350 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53452,8 +53471,8 @@ paths: parameters: - *308 - *309 - - *349 - - *353 + - *347 + - *351 - *17 - *19 responses: @@ -53471,9 +53490,9 @@ paths: type: integer jobs: type: array - items: *354 + items: *352 examples: - default: &355 + default: &353 value: total_count: 1 jobs: @@ -53588,8 +53607,8 @@ paths: parameters: - *308 - *309 - - *349 - - *353 + - *347 + - *351 responses: '302': description: Response @@ -53619,13 +53638,13 @@ paths: parameters: - *308 - *309 - - *349 + - *347 responses: '202': description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -53654,7 +53673,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 requestBody: required: true content: @@ -53723,13 +53742,13 @@ paths: parameters: - *308 - *309 - - *349 + - *347 responses: '202': description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -53758,7 +53777,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 - 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 @@ -53788,9 +53807,9 @@ paths: type: integer jobs: type: array - items: *354 + items: *352 examples: - default: *355 + default: *353 headers: Link: *52 x-github: @@ -53817,7 +53836,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 responses: '302': description: Response @@ -53846,7 +53865,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 responses: '204': description: Response @@ -53875,7 +53894,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 responses: '200': description: Response @@ -53944,7 +53963,7 @@ paths: items: type: object properties: - type: &467 + type: &465 type: string description: The type of reviewer. enum: @@ -53955,7 +53974,7 @@ paths: reviewer: anyOf: - *4 - - *169 + - *170 required: - environment - wait_timer @@ -54032,7 +54051,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 requestBody: required: true content: @@ -54082,7 +54101,7 @@ paths: application/json: schema: type: array - items: &462 + items: &460 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -54194,7 +54213,7 @@ paths: - created_at - updated_at examples: - default: &463 + default: &461 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -54252,7 +54271,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 requestBody: required: false content: @@ -54274,7 +54293,7 @@ paths: description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -54299,7 +54318,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 requestBody: required: false content: @@ -54321,7 +54340,7 @@ paths: description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -54355,7 +54374,7 @@ paths: parameters: - *308 - *309 - - *349 + - *347 responses: '200': description: Response @@ -54511,9 +54530,9 @@ paths: type: integer secrets: type: array - items: *356 + items: *354 examples: - default: *357 + default: *355 headers: Link: *52 x-github: @@ -54545,9 +54564,9 @@ paths: description: Response content: application/json: - schema: *358 + schema: *356 examples: - default: *359 + default: *357 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54571,15 +54590,15 @@ paths: parameters: - *308 - *309 - - *143 + - *144 responses: '200': description: Response content: application/json: - schema: *356 + schema: *354 examples: - default: &480 + default: &478 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -54607,7 +54626,7 @@ paths: parameters: - *308 - *309 - - *143 + - *144 requestBody: required: true content: @@ -54638,7 +54657,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -54666,7 +54685,7 @@ paths: parameters: - *308 - *309 - - *143 + - *144 responses: '204': description: Response @@ -54693,7 +54712,7 @@ paths: parameters: - *308 - *309 - - *327 + - *325 - *19 responses: '200': @@ -54710,9 +54729,9 @@ paths: type: integer variables: type: array - items: *360 + items: *358 examples: - default: *361 + default: *359 headers: Link: *52 x-github: @@ -54763,7 +54782,7 @@ paths: description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -54790,15 +54809,15 @@ paths: parameters: - *308 - *309 - - *146 + - *147 responses: '200': description: Response content: application/json: - schema: *360 + schema: *358 examples: - default: &481 + default: &479 value: name: USERNAME value: octocat @@ -54826,7 +54845,7 @@ paths: parameters: - *308 - *309 - - *146 + - *147 requestBody: required: true content: @@ -54870,7 +54889,7 @@ paths: parameters: - *308 - *309 - - *146 + - *147 responses: '204': description: Response @@ -54914,7 +54933,7 @@ paths: type: integer workflows: type: array - items: &362 + items: &360 title: Workflow description: A GitHub Actions workflow type: object @@ -55034,7 +55053,7 @@ paths: parameters: - *308 - *309 - - &363 + - &361 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -55049,7 +55068,7 @@ paths: description: Response content: application/json: - schema: *362 + schema: *360 examples: default: value: @@ -55084,7 +55103,7 @@ paths: parameters: - *308 - *309 - - *363 + - *361 responses: '204': description: Response @@ -55111,7 +55130,7 @@ paths: parameters: - *308 - *309 - - *363 + - *361 responses: '204': description: Response @@ -55164,7 +55183,7 @@ paths: parameters: - *308 - *309 - - *363 + - *361 responses: '204': description: Response @@ -55193,17 +55212,17 @@ paths: parameters: - *308 - *309 + - *361 + - *362 - *363 - *364 - *365 - - *366 - - *367 - *17 - *19 + - *366 + - *345 + - *367 - *368 - - *347 - - *369 - - *370 responses: '200': description: Response @@ -55219,9 +55238,9 @@ paths: type: integer workflow_runs: type: array - items: *348 + items: *346 examples: - default: *371 + default: *369 headers: Link: *52 x-github: @@ -55255,7 +55274,7 @@ paths: parameters: - *308 - *309 - - *363 + - *361 responses: '200': description: Response @@ -55731,7 +55750,7 @@ paths: initiator: type: string examples: - default: *372 + default: *370 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55760,7 +55779,7 @@ paths: application/json: schema: type: array - items: &373 + items: &371 title: Autolink reference description: An autolink reference. type: object @@ -55859,9 +55878,9 @@ paths: description: response content: application/json: - schema: *373 + schema: *371 examples: - default: &374 + default: &372 value: id: 1 key_prefix: TICKET- @@ -55894,7 +55913,7 @@ paths: parameters: - *308 - *309 - - &375 + - &373 name: autolink_id description: The unique identifier of the autolink. in: path @@ -55906,9 +55925,9 @@ paths: description: Response content: application/json: - schema: *373 + schema: *371 examples: - default: *374 + default: *372 '404': *6 x-github: githubCloudOnly: false @@ -55930,7 +55949,7 @@ paths: parameters: - *308 - *309 - - *375 + - *373 responses: '204': description: Response @@ -56087,7 +56106,7 @@ paths: - url protected: type: boolean - protection: &377 + protection: &375 title: Branch Protection description: Branch Protection type: object @@ -56130,7 +56149,7 @@ paths: required: - contexts - checks - enforce_admins: &380 + enforce_admins: &378 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -56147,7 +56166,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &382 + required_pull_request_reviews: &380 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -56169,7 +56188,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *169 + items: *170 apps: description: The list of apps with review dismissal access. @@ -56201,7 +56220,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *169 + items: *170 apps: description: The list of apps allowed to bypass pull request requirements. @@ -56231,7 +56250,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &379 + restrictions: &377 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -56294,7 +56313,7 @@ paths: type: string teams: type: array - items: *169 + items: *170 apps: type: array items: @@ -56526,7 +56545,7 @@ paths: parameters: - *308 - *309 - - &378 + - &376 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). @@ -56540,14 +56559,14 @@ paths: description: Response content: application/json: - schema: &388 + schema: &386 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &438 + commit: &436 title: Commit description: Commit type: object @@ -56586,7 +56605,7 @@ paths: author: anyOf: - type: 'null' - - &376 + - &374 title: Git User description: Metaproperties for Git author/committer information. @@ -56607,7 +56626,7 @@ paths: committer: anyOf: - type: 'null' - - *376 + - *374 message: type: string examples: @@ -56631,7 +56650,7 @@ paths: required: - sha - url - verification: &487 + verification: &485 title: Verification type: object properties: @@ -56667,14 +56686,14 @@ paths: author: oneOf: - *4 - - *144 + - *145 type: - 'null' - object committer: oneOf: - *4 - - *144 + - *145 type: - 'null' - object @@ -56711,7 +56730,7 @@ paths: type: integer files: type: array - items: &449 + items: &447 title: Diff Entry description: Diff Entry type: object @@ -56807,7 +56826,7 @@ paths: - self protected: type: boolean - protection: *377 + protection: *375 protection_url: type: string format: uri @@ -56916,7 +56935,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *317 + '301': *315 '404': *6 x-github: githubCloudOnly: false @@ -56940,13 +56959,13 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response content: application/json: - schema: *377 + schema: *375 examples: default: value: @@ -57142,7 +57161,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: true content: @@ -57402,7 +57421,7 @@ paths: url: type: string format: uri - required_status_checks: &385 + required_status_checks: &383 title: Status Check Policy description: Status Check Policy type: object @@ -57483,7 +57502,7 @@ paths: items: *4 teams: type: array - items: *169 + items: *170 apps: type: array items: *5 @@ -57501,7 +57520,7 @@ paths: items: *4 teams: type: array - items: *169 + items: *170 apps: type: array items: *5 @@ -57561,7 +57580,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *379 + restrictions: *377 required_conversation_resolution: type: object properties: @@ -57675,7 +57694,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '204': description: Response @@ -57702,15 +57721,15 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response content: application/json: - schema: *380 + schema: *378 examples: - default: &381 + default: &379 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -57734,15 +57753,15 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response content: application/json: - schema: *380 + schema: *378 examples: - default: *381 + default: *379 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57763,7 +57782,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '204': description: Response @@ -57790,15 +57809,15 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response content: application/json: - schema: *382 + schema: *380 examples: - default: &383 + default: &381 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -57896,7 +57915,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: false content: @@ -57994,9 +58013,9 @@ paths: description: Response content: application/json: - schema: *382 + schema: *380 examples: - default: *383 + default: *381 '422': *15 x-github: githubCloudOnly: false @@ -58019,7 +58038,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '204': description: Response @@ -58048,15 +58067,15 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response content: application/json: - schema: *380 + schema: *378 examples: - default: &384 + default: &382 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -58081,15 +58100,15 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response content: application/json: - schema: *380 + schema: *378 examples: - default: *384 + default: *382 '404': *6 x-github: githubCloudOnly: false @@ -58111,7 +58130,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '204': description: Response @@ -58138,15 +58157,15 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response content: application/json: - schema: *385 + schema: *383 examples: - default: &386 + default: &384 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -58174,7 +58193,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: false content: @@ -58226,9 +58245,9 @@ paths: description: Response content: application/json: - schema: *385 + schema: *383 examples: - default: *386 + default: *384 '404': *6 '422': *15 x-github: @@ -58252,7 +58271,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '204': description: Response @@ -58278,7 +58297,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response @@ -58314,7 +58333,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: false content: @@ -58383,7 +58402,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: false content: @@ -58449,7 +58468,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: content: application/json: @@ -58517,13 +58536,13 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response content: application/json: - schema: *379 + schema: *377 examples: default: value: @@ -58616,7 +58635,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '204': description: Response @@ -58641,7 +58660,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response @@ -58651,7 +58670,7 @@ paths: type: array items: *5 examples: - default: &387 + default: &385 value: - id: 1 slug: octoapp @@ -58710,7 +58729,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: true content: @@ -58744,7 +58763,7 @@ paths: type: array items: *5 examples: - default: *387 + default: *385 '422': *15 x-github: githubCloudOnly: false @@ -58767,7 +58786,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: true content: @@ -58801,7 +58820,7 @@ paths: type: array items: *5 examples: - default: *387 + default: *385 '422': *15 x-github: githubCloudOnly: false @@ -58824,7 +58843,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: true content: @@ -58858,7 +58877,7 @@ paths: type: array items: *5 examples: - default: *387 + default: *385 '422': *15 x-github: githubCloudOnly: false @@ -58882,7 +58901,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response @@ -58890,9 +58909,9 @@ paths: application/json: schema: type: array - items: *169 + items: *170 examples: - default: *221 + default: *222 '404': *6 x-github: githubCloudOnly: false @@ -58914,7 +58933,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: false content: @@ -58950,9 +58969,9 @@ paths: application/json: schema: type: array - items: *169 + items: *170 examples: - default: *221 + default: *222 '422': *15 x-github: githubCloudOnly: false @@ -58975,7 +58994,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: false content: @@ -59011,9 +59030,9 @@ paths: application/json: schema: type: array - items: *169 + items: *170 examples: - default: *221 + default: *222 '422': *15 x-github: githubCloudOnly: false @@ -59036,7 +59055,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: content: application/json: @@ -59071,9 +59090,9 @@ paths: application/json: schema: type: array - items: *169 + items: *170 examples: - default: *221 + default: *222 '422': *15 x-github: githubCloudOnly: false @@ -59097,7 +59116,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 responses: '200': description: Response @@ -59133,7 +59152,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: true content: @@ -59193,7 +59212,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: true content: @@ -59253,7 +59272,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: true content: @@ -59315,7 +59334,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 requestBody: required: true content: @@ -59337,7 +59356,7 @@ paths: description: Response content: application/json: - schema: *388 + schema: *386 examples: default: value: @@ -59733,7 +59752,7 @@ paths: description: Response content: application/json: - schema: &390 + schema: &388 title: CheckRun description: A check performed on the code of a given code change type: object @@ -59868,8 +59887,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *389 - deployment: &694 + items: *387 + deployment: &693 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -60158,7 +60177,7 @@ paths: parameters: - *308 - *309 - - &391 + - &389 name: check_run_id description: The unique identifier of the check run. in: path @@ -60170,9 +60189,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *388 examples: - default: &392 + default: &390 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -60274,7 +60293,7 @@ paths: parameters: - *308 - *309 - - *391 + - *389 requestBody: required: true content: @@ -60514,9 +60533,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *388 examples: - default: *392 + default: *390 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60538,7 +60557,7 @@ paths: parameters: - *308 - *309 - - *391 + - *389 - *17 - *19 responses: @@ -60650,13 +60669,13 @@ paths: parameters: - *308 - *309 - - *391 + - *389 responses: '201': description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -60717,7 +60736,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &394 + schema: &392 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -60799,12 +60818,12 @@ paths: type: - array - 'null' - items: *389 + items: *387 app: anyOf: - type: 'null' - *5 - repository: *135 + repository: *136 created_at: type: - string @@ -60815,7 +60834,7 @@ paths: - string - 'null' format: date-time - head_commit: *393 + head_commit: *391 latest_check_runs_count: type: integer check_runs_url: @@ -60843,7 +60862,7 @@ paths: - check_runs_url - pull_requests examples: - default: &395 + default: &393 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -61134,9 +61153,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *394 + schema: *392 examples: - default: *395 + default: *393 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61217,7 +61236,7 @@ paths: required: - app_id - setting - repository: *135 + repository: *136 examples: default: value: @@ -61467,7 +61486,7 @@ paths: parameters: - *308 - *309 - - &396 + - &394 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -61479,9 +61498,9 @@ paths: description: Response content: application/json: - schema: *394 + schema: *392 examples: - default: *395 + default: *393 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61506,15 +61525,15 @@ paths: parameters: - *308 - *309 - - *396 - - &444 + - *394 + - &442 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &445 + - &443 name: status description: Returns check runs with the specified `status`. in: query @@ -61553,9 +61572,9 @@ paths: type: integer check_runs: type: array - items: *390 + items: *388 examples: - default: &446 + default: &444 value: total_count: 1 check_runs: @@ -61659,13 +61678,13 @@ paths: parameters: - *308 - *309 - - *396 + - *394 responses: '201': description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -61694,19 +61713,19 @@ paths: parameters: - *308 - *309 - - *397 - - *398 + - *395 + - *396 - *19 - *17 - - &415 + - &413 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: *399 - - &416 + schema: *397 + - &414 name: pr description: The number of the pull request for the results you want to list. in: query @@ -61731,13 +61750,13 @@ paths: be returned. in: query required: false - schema: *400 + schema: *398 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *401 + schema: *399 responses: '200': description: Response @@ -61748,24 +61767,24 @@ paths: items: type: object properties: - number: *151 - created_at: *152 - updated_at: *153 - url: *154 - html_url: *155 - instances_url: *402 - state: *160 - fixed_at: *156 + number: *152 + created_at: *153 + updated_at: *154 + url: *155 + html_url: *156 + instances_url: *400 + state: *161 + fixed_at: *157 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *157 - dismissed_reason: *403 - dismissed_comment: *404 - rule: *405 - tool: *406 - most_recent_instance: *407 + dismissed_at: *158 + dismissed_reason: *401 + dismissed_comment: *402 + rule: *403 + tool: *404 + most_recent_instance: *405 dismissal_approved_by: anyOf: - type: 'null' @@ -61888,7 +61907,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &408 + '403': &406 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -61917,7 +61936,7 @@ paths: parameters: - *308 - *309 - - &409 + - &407 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -61925,30 +61944,30 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *151 + schema: *152 responses: '200': description: Response content: application/json: - schema: &410 + schema: &408 type: object properties: - number: *151 - created_at: *152 - updated_at: *153 - url: *154 - html_url: *155 - instances_url: *402 - state: *160 - fixed_at: *156 + number: *152 + created_at: *153 + updated_at: *154 + url: *155 + html_url: *156 + instances_url: *400 + state: *161 + fixed_at: *157 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *157 - dismissed_reason: *403 - dismissed_comment: *404 + dismissed_at: *158 + dismissed_reason: *401 + dismissed_comment: *402 rule: type: object properties: @@ -62010,8 +62029,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *406 - most_recent_instance: *407 + tool: *404 + most_recent_instance: *405 dismissal_approved_by: anyOf: - type: 'null' @@ -62107,7 +62126,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *408 + '403': *406 '404': *6 '503': *97 x-github: @@ -62129,7 +62148,7 @@ paths: parameters: - *308 - *309 - - *409 + - *407 requestBody: required: true content: @@ -62144,8 +62163,8 @@ paths: enum: - open - dismissed - dismissed_reason: *403 - dismissed_comment: *404 + dismissed_reason: *401 + dismissed_comment: *402 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -62164,7 +62183,7 @@ paths: description: Response content: application/json: - schema: *410 + schema: *408 examples: default: value: @@ -62240,7 +62259,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &414 + '403': &412 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -62269,13 +62288,13 @@ paths: parameters: - *308 - *309 - - *409 + - *407 responses: '200': description: Response content: application/json: - schema: &411 + schema: &409 type: object properties: status: @@ -62302,13 +62321,13 @@ paths: - description - started_at examples: - default: &412 + default: &410 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &413 + '400': &411 description: Bad Request content: application/json: @@ -62319,7 +62338,7 @@ 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': *408 + '403': *406 '404': *6 '503': *97 x-github: @@ -62346,27 +62365,27 @@ paths: parameters: - *308 - *309 - - *409 + - *407 responses: '200': description: OK content: application/json: - schema: *411 + schema: *409 examples: - default: *412 + default: *410 '202': description: Accepted content: application/json: - schema: *411 + schema: *409 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *413 + '400': *411 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -62400,7 +62419,7 @@ paths: parameters: - *308 - *309 - - *409 + - *407 requestBody: required: false content: @@ -62446,8 +62465,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *413 - '403': *414 + '400': *411 + '403': *412 '404': *6 '422': description: Unprocessable Entity @@ -62473,11 +62492,11 @@ paths: parameters: - *308 - *309 - - *409 + - *407 - *19 - *17 - - *415 - - *416 + - *413 + - *414 responses: '200': description: Response @@ -62485,7 +62504,7 @@ paths: application/json: schema: type: array - items: *407 + items: *405 examples: default: value: @@ -62524,7 +62543,7 @@ paths: end_column: 50 classifications: - source - '403': *408 + '403': *406 '404': *6 '503': *97 x-github: @@ -62560,23 +62579,23 @@ paths: parameters: - *308 - *309 - - *397 - - *398 + - *395 + - *396 - *19 - *17 - - *416 + - *414 - 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: *399 + schema: *397 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &419 + schema: &417 type: string description: An identifier for the upload. examples: @@ -62598,23 +62617,23 @@ paths: application/json: schema: type: array - items: &420 + items: &418 type: object properties: - ref: *399 - commit_sha: &428 + ref: *397 + commit_sha: &426 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: *417 + analysis_key: *415 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *418 + category: *416 error: type: string examples: @@ -62639,8 +62658,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *419 - tool: *406 + sarif_id: *417 + tool: *404 deletable: type: boolean warning: @@ -62702,7 +62721,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *408 + '403': *406 '404': *6 '503': *97 x-github: @@ -62752,7 +62771,7 @@ paths: description: Response content: application/json: - schema: *420 + schema: *418 examples: response: summary: application/json response @@ -62806,7 +62825,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *408 + '403': *406 '404': *6 '422': description: Response if analysis could not be processed @@ -62950,7 +62969,7 @@ 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': *414 + '403': *412 '404': *6 '503': *97 x-github: @@ -62981,7 +63000,7 @@ paths: application/json: schema: type: array - items: &421 + items: &419 title: CodeQL Database description: A CodeQL database. type: object @@ -63093,7 +63112,7 @@ 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': *408 + '403': *406 '404': *6 '503': *97 x-github: @@ -63135,7 +63154,7 @@ paths: description: Response content: application/json: - schema: *421 + schema: *419 examples: default: value: @@ -63167,9 +63186,9 @@ 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': &451 + '302': &449 description: Found - '403': *408 + '403': *406 '404': *6 '503': *97 x-github: @@ -63202,7 +63221,7 @@ paths: responses: '204': description: Response - '403': *414 + '403': *412 '404': *6 '503': *97 x-github: @@ -63240,7 +63259,7 @@ paths: type: object additionalProperties: false properties: - language: &422 + language: &420 type: string description: The language targeted by the CodeQL query enum: @@ -63319,7 +63338,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &426 + schema: &424 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -63329,7 +63348,7 @@ paths: description: The ID of the variant analysis. controller_repo: *51 actor: *4 - query_language: *422 + query_language: *420 query_pack_url: type: string description: The download url for the query pack. @@ -63377,7 +63396,7 @@ paths: items: type: object properties: - repository: &423 + repository: &421 title: Repository Identifier description: Repository Identifier type: object @@ -63419,7 +63438,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &427 + analysis_status: &425 type: string description: The new status of the CodeQL variant analysis repository task. @@ -63451,7 +63470,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &424 + access_mismatch_repos: &422 type: object properties: repository_count: @@ -63466,7 +63485,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: *423 + items: *421 required: - repository_count - repositories @@ -63489,8 +63508,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *424 - over_limit_repos: *424 + no_codeql_db_repos: *422 + over_limit_repos: *422 required: - access_mismatch_repos - not_found_repos @@ -63506,7 +63525,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &425 + value: &423 summary: Default response value: id: 1 @@ -63658,10 +63677,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *425 + value: *423 repository_lists: summary: Response for a successful variant analysis submission - value: *425 + value: *423 '404': *6 '422': description: Unable to process variant analysis submission @@ -63702,9 +63721,9 @@ paths: description: Response content: application/json: - schema: *426 + schema: *424 examples: - default: *425 + default: *423 '404': *6 '503': *97 x-github: @@ -63762,7 +63781,7 @@ paths: type: object properties: repository: *51 - analysis_status: *427 + analysis_status: *425 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -63981,7 +64000,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *408 + '403': *406 '404': *6 '503': *97 x-github: @@ -64072,7 +64091,7 @@ paths: description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -64097,7 +64116,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *414 + '403': *412 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -64177,7 +64196,7 @@ paths: schema: type: object properties: - commit_sha: *428 + commit_sha: *426 ref: type: string description: |- @@ -64237,7 +64256,7 @@ paths: schema: type: object properties: - id: *419 + id: *417 url: type: string description: The REST API URL for checking the status of the upload. @@ -64251,7 +64270,7 @@ 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': *414 + '403': *412 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -64323,7 +64342,7 @@ 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': *408 + '403': *406 '404': description: Not Found if the sarif id does not match any upload '503': *97 @@ -64405,7 +64424,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': *165 + '204': *166 '304': *35 '403': *27 '404': *6 @@ -64576,7 +64595,7 @@ paths: type: integer codespaces: type: array - items: *210 + items: *211 examples: default: value: @@ -64939,17 +64958,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '400': *14 '401': *23 '403': *27 @@ -65081,9 +65100,9 @@ paths: type: integer machines: type: array - items: *430 + items: *428 examples: - default: &643 + default: &642 value: total_count: 2 machines: @@ -65300,7 +65319,7 @@ paths: type: integer secrets: type: array - items: &434 + items: &432 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -65321,7 +65340,7 @@ paths: - created_at - updated_at examples: - default: *431 + default: *429 headers: Link: *52 x-github: @@ -65351,9 +65370,9 @@ paths: description: Response content: application/json: - schema: *432 + schema: *430 examples: - default: *433 + default: *431 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65375,15 +65394,15 @@ paths: parameters: - *308 - *309 - - *143 + - *144 responses: '200': description: Response content: application/json: - schema: *434 + schema: *432 examples: - default: *435 + default: *433 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65405,7 +65424,7 @@ paths: parameters: - *308 - *309 - - *143 + - *144 requestBody: required: true content: @@ -65433,7 +65452,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -65459,7 +65478,7 @@ paths: parameters: - *308 - *309 - - *143 + - *144 responses: '204': description: Response @@ -65526,7 +65545,7 @@ paths: application/json: schema: type: array - items: &436 + items: &434 title: Collaborator description: Collaborator type: object @@ -65795,7 +65814,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &500 + schema: &498 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -65807,7 +65826,7 @@ paths: format: int64 examples: - 42 - repository: *135 + repository: *136 invitee: anyOf: - type: 'null' @@ -65983,7 +66002,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *104 + schema: *105 '403': *27 x-github: triggersNotification: true @@ -66078,7 +66097,7 @@ paths: user: anyOf: - type: 'null' - - *436 + - *434 required: - permission - role_name @@ -66143,7 +66162,7 @@ paths: application/json: schema: type: array - items: &437 + items: &435 title: Commit Comment description: Commit Comment type: object @@ -66201,7 +66220,7 @@ paths: - created_at - updated_at examples: - default: &440 + default: &438 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66268,9 +66287,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *435 examples: - default: &441 + default: &439 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66351,7 +66370,7 @@ paths: description: Response content: application/json: - schema: *437 + schema: *435 examples: default: value: @@ -66650,9 +66669,9 @@ paths: application/json: schema: type: array - items: *438 + items: *436 examples: - default: &549 + default: &548 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -66748,7 +66767,7 @@ paths: parameters: - *308 - *309 - - &439 + - &437 name: commit_sha description: The SHA of the commit. in: path @@ -66822,7 +66841,7 @@ paths: parameters: - *308 - *309 - - *439 + - *437 - *17 - *19 responses: @@ -66832,9 +66851,9 @@ paths: application/json: schema: type: array - items: *437 + items: *435 examples: - default: *440 + default: *438 headers: Link: *52 x-github: @@ -66864,7 +66883,7 @@ paths: parameters: - *308 - *309 - - *439 + - *437 requestBody: required: true content: @@ -66899,9 +66918,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *435 examples: - default: *441 + default: *439 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66931,7 +66950,7 @@ paths: parameters: - *308 - *309 - - *439 + - *437 - *17 - *19 responses: @@ -66941,9 +66960,9 @@ paths: application/json: schema: type: array - items: *442 + items: *440 examples: - default: &541 + default: &540 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -67484,7 +67503,7 @@ paths: - *309 - *19 - *17 - - &443 + - &441 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)" @@ -67499,9 +67518,9 @@ paths: description: Response content: application/json: - schema: *438 + schema: *436 examples: - default: &527 + default: &526 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -67616,9 +67635,9 @@ paths: parameters: - *308 - *309 + - *441 + - *442 - *443 - - *444 - - *445 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -67652,9 +67671,9 @@ paths: type: integer check_runs: type: array - items: *390 + items: *388 examples: - default: *446 + default: *444 headers: Link: *52 x-github: @@ -67681,7 +67700,7 @@ paths: parameters: - *308 - *309 - - *443 + - *441 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -67689,7 +67708,7 @@ paths: schema: type: integer example: 1 - - *444 + - *442 - *17 - *19 responses: @@ -67707,7 +67726,7 @@ paths: type: integer check_suites: type: array - items: *394 + items: *392 examples: default: value: @@ -67909,7 +67928,7 @@ paths: parameters: - *308 - *309 - - *443 + - *441 - *17 - *19 responses: @@ -67980,7 +67999,7 @@ paths: type: string total_count: type: integer - repository: *135 + repository: *136 commit_url: type: string format: uri @@ -68113,7 +68132,7 @@ paths: parameters: - *308 - *309 - - *443 + - *441 - *17 - *19 responses: @@ -68123,7 +68142,7 @@ paths: application/json: schema: type: array - items: &614 + items: &613 title: Status description: The status of a commit. type: object @@ -68204,7 +68223,7 @@ paths: site_admin: false headers: Link: *52 - '301': *317 + '301': *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68266,11 +68285,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *447 + - *445 code_of_conduct_file: anyOf: - type: 'null' - - &448 + - &446 title: Community Health File type: object properties: @@ -68290,19 +68309,19 @@ paths: contributing: anyOf: - type: 'null' - - *448 + - *446 readme: anyOf: - type: 'null' - - *448 + - *446 issue_template: anyOf: - type: 'null' - - *448 + - *446 pull_request_template: anyOf: - type: 'null' - - *448 + - *446 required: - code_of_conduct - code_of_conduct_file @@ -68480,8 +68499,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *438 - merge_base_commit: *438 + base_commit: *436 + merge_base_commit: *436 status: type: string enum: @@ -68505,10 +68524,10 @@ paths: - 6 commits: type: array - items: *438 + items: *436 files: type: array - items: *449 + items: *447 required: - url - html_url @@ -68948,7 +68967,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &450 + response-if-content-is-a-file: &448 summary: Response if content is a file value: type: file @@ -69085,7 +69104,7 @@ paths: - size - type - url - - &554 + - &553 title: Content File description: Content File type: object @@ -69303,7 +69322,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *450 + response-if-content-is-a-file: *448 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -69372,7 +69391,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *451 + '302': *449 '304': *35 x-github: githubCloudOnly: false @@ -69491,7 +69510,7 @@ paths: description: Response content: application/json: - schema: &452 + schema: &450 title: File Commit description: File Commit type: object @@ -69647,7 +69666,7 @@ paths: description: Response content: application/json: - schema: *452 + schema: *450 examples: example-for-creating-a-file: value: @@ -69701,7 +69720,7 @@ paths: schema: oneOf: - *3 - - &482 + - &480 description: Repository rule violation was detected type: object properties: @@ -69722,7 +69741,7 @@ paths: items: type: object properties: - placeholder_id: &606 + placeholder_id: &605 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -69816,7 +69835,7 @@ paths: description: Response content: application/json: - schema: *452 + schema: *450 examples: default: value: @@ -69998,20 +70017,20 @@ paths: parameters: - *308 - *309 - - *170 - *171 - *172 - *173 + - *174 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *174 - - *453 - *175 + - *451 - *176 + - *177 - *46 - name: per_page description: The number of results per page (max 100). For more information, @@ -70030,11 +70049,11 @@ paths: application/json: schema: type: array - items: &456 + items: &454 type: object description: A Dependabot alert. properties: - number: *151 + number: *152 state: type: string description: The state of the Dependabot alert. @@ -70080,13 +70099,13 @@ paths: - direct - transitive - - security_advisory: *454 + security_advisory: *452 security_vulnerability: *50 - url: *154 - html_url: *155 - created_at: *152 - updated_at: *153 - dismissed_at: *157 + url: *155 + html_url: *156 + created_at: *153 + updated_at: *154 + dismissed_at: *158 dismissed_by: anyOf: - type: 'null' @@ -70110,8 +70129,8 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: *156 - auto_dismissed_at: *455 + fixed_at: *157 + auto_dismissed_at: *453 required: - number - state @@ -70343,7 +70362,7 @@ paths: parameters: - *308 - *309 - - &457 + - &455 name: alert_number in: path description: |- @@ -70352,13 +70371,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *151 + schema: *152 responses: '200': description: Response content: application/json: - schema: *456 + schema: *454 examples: default: value: @@ -70473,7 +70492,7 @@ paths: parameters: - *308 - *309 - - *457 + - *455 requestBody: required: true content: @@ -70518,7 +70537,7 @@ paths: description: Response content: application/json: - schema: *456 + schema: *454 examples: default: value: @@ -70666,7 +70685,7 @@ paths: type: integer secrets: type: array - items: &460 + items: &458 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -70727,9 +70746,9 @@ paths: description: Response content: application/json: - schema: *458 + schema: *456 examples: - default: *459 + default: *457 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70751,13 +70770,13 @@ paths: parameters: - *308 - *309 - - *143 + - *144 responses: '200': description: Response content: application/json: - schema: *460 + schema: *458 examples: default: value: @@ -70785,7 +70804,7 @@ paths: parameters: - *308 - *309 - - *143 + - *144 requestBody: required: true content: @@ -70813,7 +70832,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -70839,7 +70858,7 @@ paths: parameters: - *308 - *309 - - *143 + - *144 responses: '204': description: Response @@ -71381,7 +71400,7 @@ paths: - version - url additionalProperties: false - metadata: &461 + metadata: &459 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -71420,7 +71439,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *461 + metadata: *459 resolved: type: object description: A collection of resolved package dependencies. @@ -71434,7 +71453,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *461 + metadata: *459 relationship: type: string description: A notation of whether a dependency is requested @@ -71609,9 +71628,9 @@ paths: application/json: schema: type: array - items: *462 + items: *460 examples: - default: *463 + default: *461 headers: Link: *52 x-github: @@ -71760,7 +71779,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *460 examples: simple-example: summary: Simple example @@ -71835,7 +71854,7 @@ paths: parameters: - *308 - *309 - - &464 + - &462 name: deployment_id description: deployment_id parameter in: path @@ -71847,7 +71866,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *460 examples: default: value: @@ -71914,7 +71933,7 @@ paths: parameters: - *308 - *309 - - *464 + - *462 responses: '204': description: Response @@ -71938,7 +71957,7 @@ paths: parameters: - *308 - *309 - - *464 + - *462 - *17 - *19 responses: @@ -71948,7 +71967,7 @@ paths: application/json: schema: type: array - items: &465 + items: &463 title: Deployment Status description: The status of a deployment. type: object @@ -72114,7 +72133,7 @@ paths: parameters: - *308 - *309 - - *464 + - *462 requestBody: required: true content: @@ -72189,9 +72208,9 @@ paths: description: Response content: application/json: - schema: *465 + schema: *463 examples: - default: &466 + default: &464 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -72249,7 +72268,7 @@ paths: parameters: - *308 - *309 - - *464 + - *462 - name: status_id in: path required: true @@ -72260,9 +72279,9 @@ paths: description: Response content: application/json: - schema: *465 + schema: *463 examples: - default: *466 + default: *464 '404': *6 x-github: githubCloudOnly: false @@ -72364,7 +72383,7 @@ paths: - 5 environments: type: array - items: &468 + items: &466 title: Environment description: Details of a deployment environment type: object @@ -72426,7 +72445,7 @@ paths: type: string examples: - wait_timer - wait_timer: &470 + wait_timer: &468 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -72468,11 +72487,11 @@ paths: items: type: object properties: - type: *467 + type: *465 reviewer: anyOf: - *4 - - *169 + - *170 required: - id - node_id @@ -72495,7 +72514,7 @@ paths: - id - node_id - type - deployment_branch_policy: &471 + deployment_branch_policy: &469 type: - object - 'null' @@ -72614,7 +72633,7 @@ paths: parameters: - *308 - *309 - - &469 + - &467 name: environment_name in: path required: true @@ -72627,9 +72646,9 @@ paths: description: Response content: application/json: - schema: *468 + schema: *466 examples: - default: &472 + default: &470 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -72715,7 +72734,7 @@ paths: parameters: - *308 - *309 - - *469 + - *467 requestBody: required: false content: @@ -72725,7 +72744,7 @@ paths: - object - 'null' properties: - wait_timer: *470 + wait_timer: *468 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -72744,14 +72763,14 @@ paths: items: type: object properties: - type: *467 + type: *465 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *471 + deployment_branch_policy: *469 additionalProperties: false examples: default: @@ -72771,9 +72790,9 @@ paths: description: Response content: application/json: - schema: *468 + schema: *466 examples: - default: *472 + default: *470 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -72799,7 +72818,7 @@ paths: parameters: - *308 - *309 - - *469 + - *467 responses: '204': description: Default response @@ -72826,7 +72845,7 @@ paths: parameters: - *308 - *309 - - *469 + - *467 - *17 - *19 responses: @@ -72845,7 +72864,7 @@ paths: - 2 branch_policies: type: array - items: &473 + items: &471 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -72908,7 +72927,7 @@ paths: parameters: - *308 - *309 - - *469 + - *467 requestBody: required: true content: @@ -72956,9 +72975,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *471 examples: - example-wildcard: &474 + example-wildcard: &472 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -73002,8 +73021,8 @@ paths: parameters: - *308 - *309 - - *469 - - &475 + - *467 + - &473 name: branch_policy_id in: path required: true @@ -73015,9 +73034,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *471 examples: - default: *474 + default: *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73038,8 +73057,8 @@ paths: parameters: - *308 - *309 - - *469 - - *475 + - *467 + - *473 requestBody: required: true content: @@ -73068,9 +73087,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *471 examples: - default: *474 + default: *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73091,8 +73110,8 @@ paths: parameters: - *308 - *309 - - *469 - - *475 + - *467 + - *473 responses: '204': description: Response @@ -73117,7 +73136,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *469 + - *467 - *309 - *308 responses: @@ -73136,7 +73155,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &476 + items: &474 title: Deployment protection rule description: Deployment protection rule type: object @@ -73158,7 +73177,7 @@ paths: for the environment. examples: - true - app: &477 + app: &475 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -73261,7 +73280,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *469 + - *467 - *309 - *308 requestBody: @@ -73284,9 +73303,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *476 + schema: *474 examples: - default: &478 + default: &476 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -73321,7 +73340,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *469 + - *467 - *309 - *308 - *19 @@ -73343,7 +73362,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *477 + items: *475 examples: default: value: @@ -73380,8 +73399,8 @@ paths: parameters: - *308 - *309 - - *469 - - &479 + - *467 + - &477 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -73393,9 +73412,9 @@ paths: description: Response content: application/json: - schema: *476 + schema: *474 examples: - default: *478 + default: *476 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73416,10 +73435,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *469 + - *467 - *309 - *308 - - *479 + - *477 responses: '204': description: Response @@ -73447,7 +73466,7 @@ paths: parameters: - *308 - *309 - - *469 + - *467 - *17 - *19 responses: @@ -73465,9 +73484,9 @@ paths: type: integer secrets: type: array - items: *356 + items: *354 examples: - default: *357 + default: *355 headers: Link: *52 x-github: @@ -73494,15 +73513,15 @@ paths: parameters: - *308 - *309 - - *469 + - *467 responses: '200': description: Response content: application/json: - schema: *358 + schema: *356 examples: - default: *359 + default: *357 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73526,16 +73545,16 @@ paths: parameters: - *308 - *309 - - *469 - - *143 + - *467 + - *144 responses: '200': description: Response content: application/json: - schema: *356 + schema: *354 examples: - default: *480 + default: *478 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73559,8 +73578,8 @@ paths: parameters: - *308 - *309 - - *469 - - *143 + - *467 + - *144 requestBody: required: true content: @@ -73591,7 +73610,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -73619,8 +73638,8 @@ paths: parameters: - *308 - *309 - - *469 - - *143 + - *467 + - *144 responses: '204': description: Default response @@ -73647,8 +73666,8 @@ paths: parameters: - *308 - *309 - - *469 - - *327 + - *467 + - *325 - *19 responses: '200': @@ -73665,9 +73684,9 @@ paths: type: integer variables: type: array - items: *360 + items: *358 examples: - default: *361 + default: *359 headers: Link: *52 x-github: @@ -73692,7 +73711,7 @@ paths: parameters: - *308 - *309 - - *469 + - *467 requestBody: required: true content: @@ -73719,7 +73738,7 @@ paths: description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -73746,16 +73765,16 @@ paths: parameters: - *308 - *309 - - *469 - - *146 + - *467 + - *147 responses: '200': description: Response content: application/json: - schema: *360 + schema: *358 examples: - default: *481 + default: *479 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73778,8 +73797,8 @@ paths: parameters: - *308 - *309 - - *146 - - *469 + - *147 + - *467 requestBody: required: true content: @@ -73823,8 +73842,8 @@ paths: parameters: - *308 - *309 - - *146 - - *469 + - *147 + - *467 responses: '204': description: Response @@ -73938,7 +73957,7 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: default: value: @@ -74109,9 +74128,9 @@ paths: description: Response content: application/json: - schema: *316 + schema: *314 examples: - default: *318 + default: *316 '400': *14 '422': *15 '403': *27 @@ -74192,8 +74211,8 @@ paths: application/json: schema: oneOf: - - *104 - - *482 + - *105 + - *480 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74429,7 +74448,7 @@ paths: description: Response content: application/json: - schema: &483 + schema: &481 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -74658,13 +74677,13 @@ paths: parameters: - *308 - *309 - - *439 + - *437 responses: '200': description: Response content: application/json: - schema: *483 + schema: *481 examples: default: value: @@ -74722,7 +74741,7 @@ paths: parameters: - *308 - *309 - - &484 + - &482 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. @@ -74739,7 +74758,7 @@ paths: application/json: schema: type: array - items: &485 + items: &483 title: Git Reference description: Git references within a repository type: object @@ -74817,15 +74836,15 @@ paths: parameters: - *308 - *309 - - *484 + - *482 responses: '200': description: Response content: application/json: - schema: *485 + schema: *483 examples: - default: &486 + default: &484 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -74884,9 +74903,9 @@ paths: description: Response content: application/json: - schema: *485 + schema: *483 examples: - default: *486 + default: *484 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -74914,7 +74933,7 @@ paths: parameters: - *308 - *309 - - *484 + - *482 requestBody: required: true content: @@ -74943,9 +74962,9 @@ paths: description: Response content: application/json: - schema: *485 + schema: *483 examples: - default: *486 + default: *484 '422': *15 '409': *45 x-github: @@ -74965,7 +74984,7 @@ paths: parameters: - *308 - *309 - - *484 + - *482 responses: '204': description: Response @@ -75088,7 +75107,7 @@ paths: description: Response content: application/json: - schema: &488 + schema: &486 title: Git Tag description: Metadata for a Git tag type: object @@ -75144,7 +75163,7 @@ paths: - sha - type - url - verification: *487 + verification: *485 required: - sha - url @@ -75154,7 +75173,7 @@ paths: - tag - message examples: - default: &489 + default: &487 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -75239,9 +75258,9 @@ paths: description: Response content: application/json: - schema: *488 + schema: *486 examples: - default: *489 + default: *487 '404': *6 '409': *45 x-github: @@ -75340,7 +75359,7 @@ paths: description: Response content: application/json: - schema: &490 + schema: &488 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -75466,7 +75485,7 @@ paths: description: Response content: application/json: - schema: *490 + schema: *488 examples: default-response: summary: Default response @@ -75536,7 +75555,7 @@ paths: application/json: schema: type: array - items: &491 + items: &489 title: Webhook description: Webhooks for repositories. type: object @@ -75599,7 +75618,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &725 + last_response: &724 title: Hook Response type: object properties: @@ -75730,9 +75749,9 @@ paths: description: Response content: application/json: - schema: *491 + schema: *489 examples: - default: &492 + default: &490 value: type: Repository id: 12345678 @@ -75782,15 +75801,15 @@ paths: parameters: - *308 - *309 - - *182 + - *183 responses: '200': description: Response content: application/json: - schema: *491 + schema: *489 examples: - default: *492 + default: *490 '404': *6 x-github: githubCloudOnly: false @@ -75812,7 +75831,7 @@ paths: parameters: - *308 - *309 - - *182 + - *183 requestBody: required: true content: @@ -75857,9 +75876,9 @@ paths: description: Response content: application/json: - schema: *491 + schema: *489 examples: - default: *492 + default: *490 '422': *15 '404': *6 x-github: @@ -75882,7 +75901,7 @@ paths: parameters: - *308 - *309 - - *182 + - *183 responses: '204': description: Response @@ -75908,7 +75927,7 @@ paths: parameters: - *308 - *309 - - *182 + - *183 responses: '200': description: Response @@ -75937,7 +75956,7 @@ paths: parameters: - *308 - *309 - - *182 + - *183 requestBody: required: false content: @@ -75983,9 +76002,9 @@ paths: parameters: - *308 - *309 - - *182 - - *17 - *183 + - *17 + - *184 responses: '200': description: Response @@ -75993,9 +76012,9 @@ paths: application/json: schema: type: array - items: *184 + items: *185 examples: - default: *185 + default: *186 '400': *14 '422': *15 x-github: @@ -76016,16 +76035,16 @@ paths: parameters: - *308 - *309 - - *182 + - *183 - *16 responses: '200': description: Response content: application/json: - schema: *186 + schema: *187 examples: - default: *187 + default: *188 '400': *14 '422': *15 x-github: @@ -76046,7 +76065,7 @@ paths: parameters: - *308 - *309 - - *182 + - *183 - *16 responses: '202': *37 @@ -76071,7 +76090,7 @@ paths: parameters: - *308 - *309 - - *182 + - *183 responses: '204': description: Response @@ -76098,7 +76117,7 @@ paths: parameters: - *308 - *309 - - *182 + - *183 responses: '204': description: Response @@ -76173,7 +76192,7 @@ paths: - *308 - *309 responses: - '204': *165 + '204': *166 '409': *45 x-github: githubCloudOnly: false @@ -76194,7 +76213,7 @@ paths: - *308 - *309 responses: - '204': *165 + '204': *166 '409': *45 x-github: githubCloudOnly: false @@ -76256,7 +76275,7 @@ paths: description: Response content: application/json: - schema: &493 + schema: &491 title: Import description: A repository import from an external source. type: object @@ -76363,7 +76382,7 @@ paths: - html_url - authors_url examples: - default: &496 + default: &494 value: vcs: subversion use_lfs: true @@ -76379,7 +76398,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': &494 + '503': &492 description: Unavailable due to service under maintenance. content: application/json: @@ -76457,7 +76476,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *491 examples: default: value: @@ -76482,7 +76501,7 @@ paths: type: string '422': *15 '404': *6 - '503': *494 + '503': *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76563,7 +76582,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *491 examples: example-1: summary: Example 1 @@ -76611,7 +76630,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': *494 + '503': *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76639,7 +76658,7 @@ paths: responses: '204': description: Response - '503': *494 + '503': *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76667,7 +76686,7 @@ paths: parameters: - *308 - *309 - - &664 + - &663 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -76681,7 +76700,7 @@ paths: application/json: schema: type: array - items: &495 + items: &493 title: Porter Author description: Porter Author type: object @@ -76735,7 +76754,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': *494 + '503': *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76791,7 +76810,7 @@ paths: description: Response content: application/json: - schema: *495 + schema: *493 examples: default: value: @@ -76804,7 +76823,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *494 + '503': *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76870,7 +76889,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *494 + '503': *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76926,11 +76945,11 @@ paths: description: Response content: application/json: - schema: *493 + schema: *491 examples: - default: *496 + default: *494 '422': *15 - '503': *494 + '503': *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76962,8 +76981,8 @@ paths: application/json: schema: *20 examples: - default: *497 - '301': *317 + default: *495 + '301': *315 '404': *6 x-github: githubCloudOnly: false @@ -76992,12 +77011,12 @@ paths: application/json: schema: anyOf: - - *200 + - *201 - type: object properties: {} additionalProperties: false examples: - default: &499 + default: &497 value: limit: collaborators_only origin: repository @@ -77028,7 +77047,7 @@ paths: required: true content: application/json: - schema: *498 + schema: *496 examples: default: summary: Example request body @@ -77040,9 +77059,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *201 examples: - default: *499 + default: *497 '409': description: Response x-github: @@ -77099,9 +77118,9 @@ paths: application/json: schema: type: array - items: *500 + items: *498 examples: - default: &657 + default: &656 value: - id: 1 repository: @@ -77234,7 +77253,7 @@ paths: parameters: - *308 - *309 - - *204 + - *205 requestBody: required: false content: @@ -77263,7 +77282,7 @@ paths: description: Response content: application/json: - schema: *500 + schema: *498 examples: default: value: @@ -77396,7 +77415,7 @@ paths: parameters: - *308 - *309 - - *204 + - *205 responses: '204': description: Response @@ -77476,7 +77495,7 @@ paths: required: false schema: type: string - - *208 + - *209 - name: sort description: What to sort results by. in: query @@ -77501,7 +77520,7 @@ paths: type: array items: *78 examples: - default: &507 + default: &506 value: - id: 1 node_id: MDU6SXNzdWUx @@ -77649,7 +77668,7 @@ paths: state_reason: completed headers: Link: *52 - '301': *317 + '301': *315 '422': *15 '404': *6 x-github: @@ -77771,7 +77790,7 @@ paths: application/json: schema: *78 examples: - default: &504 + default: &503 value: id: 1 node_id: MDU6SXNzdWUx @@ -77927,7 +77946,7 @@ paths: '422': *15 '503': *97 '404': *6 - '410': *314 + '410': *499 x-github: triggersNotification: true githubCloudOnly: false @@ -77977,9 +77996,9 @@ paths: application/json: schema: type: array - items: *501 + items: *500 examples: - default: &506 + default: &505 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -78045,9 +78064,9 @@ paths: description: Response content: application/json: - schema: *501 + schema: *500 examples: - default: &502 + default: &501 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -78125,9 +78144,9 @@ paths: description: Response content: application/json: - schema: *501 + schema: *500 examples: - default: *502 + default: *501 '422': *15 x-github: githubCloudOnly: false @@ -78317,7 +78336,7 @@ paths: application/json: schema: type: array - items: &503 + items: &502 title: Issue Event description: Issue Event type: object @@ -78397,7 +78416,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *169 + requested_team: *170 dismissed_review: title: Issue Event Dismissed Review type: object @@ -78668,7 +78687,7 @@ paths: description: Response content: application/json: - schema: *503 + schema: *502 examples: default: value: @@ -78861,7 +78880,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *314 + '410': *499 '403': *27 x-github: githubCloudOnly: false @@ -78897,7 +78916,7 @@ paths: parameters: - *308 - *309 - - &505 + - &504 name: issue_number description: The number that identifies the issue. in: path @@ -78911,10 +78930,10 @@ paths: application/json: schema: *78 examples: - default: *504 - '301': *317 + default: *503 + '301': *315 '404': *6 - '410': *314 + '410': *499 '304': *35 x-github: githubCloudOnly: false @@ -78941,7 +78960,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: false content: @@ -79062,13 +79081,13 @@ paths: application/json: schema: *78 examples: - default: *504 + default: *503 '422': *15 '503': *97 '403': *27 - '301': *317 + '301': *315 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79088,7 +79107,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: false content: @@ -79116,7 +79135,7 @@ paths: application/json: schema: *78 examples: - default: *504 + default: *503 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79134,7 +79153,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: content: application/json: @@ -79161,7 +79180,7 @@ paths: application/json: schema: *78 examples: - default: *504 + default: *503 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79185,7 +79204,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - name: assignee in: path required: true @@ -79227,7 +79246,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - *68 - *17 - *19 @@ -79238,13 +79257,13 @@ paths: application/json: schema: type: array - items: *501 + items: *500 examples: - default: *506 + default: *505 headers: Link: *52 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79275,7 +79294,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: true content: @@ -79297,16 +79316,16 @@ paths: description: Response content: application/json: - schema: *501 + schema: *500 examples: - default: *502 + default: *501 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *314 + '410': *499 '422': *15 '404': *6 x-github: @@ -79336,7 +79355,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - *17 - *19 responses: @@ -79348,12 +79367,12 @@ paths: type: array items: *78 examples: - default: *507 + default: *506 headers: Link: *52 - '301': *317 + '301': *315 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79383,7 +79402,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: true content: @@ -79407,15 +79426,15 @@ paths: application/json: schema: *78 examples: - default: *504 + default: *503 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *317 + '301': *315 '403': *27 - '410': *314 + '410': *499 '422': *15 '404': *6 x-github: @@ -79448,7 +79467,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -79462,13 +79481,13 @@ paths: application/json: schema: *78 examples: - default: *504 - '301': *317 + default: *503 + '301': *315 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *314 + '410': *499 x-github: triggersNotification: true githubCloudOnly: false @@ -79496,7 +79515,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - *17 - *19 responses: @@ -79508,12 +79527,12 @@ paths: type: array items: *78 examples: - default: *507 + default: *506 headers: Link: *52 - '301': *317 + '301': *315 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79532,7 +79551,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - *17 - *19 responses: @@ -79546,7 +79565,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &510 + - &509 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -79595,7 +79614,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &511 + - &510 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -79723,7 +79742,7 @@ paths: - performed_via_github_app - assignee - assigner - - &512 + - &511 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -79769,7 +79788,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &513 + - &512 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -79815,7 +79834,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &514 + - &513 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -79864,7 +79883,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &515 + - &514 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -79893,7 +79912,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *169 + requested_team: *170 requested_reviewer: *4 required: - review_requester @@ -79906,7 +79925,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &516 + - &515 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -79935,7 +79954,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *169 + requested_team: *170 requested_reviewer: *4 required: - review_requester @@ -79948,7 +79967,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &517 + - &516 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -80004,7 +80023,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &518 + - &517 title: Locked Issue Event description: Locked Issue Event type: object @@ -80049,7 +80068,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &519 + - &518 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -80110,7 +80129,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &520 + - &519 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -80171,7 +80190,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &521 + - &520 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -80232,7 +80251,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &522 + - &521 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -80325,7 +80344,7 @@ paths: color: red headers: Link: *52 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80344,7 +80363,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - *17 - *19 responses: @@ -80354,7 +80373,7 @@ paths: application/json: schema: type: array - items: &508 + items: &507 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -80409,7 +80428,7 @@ paths: - color - default examples: - default: &509 + default: &508 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -80427,9 +80446,9 @@ paths: default: false headers: Link: *52 - '301': *317 + '301': *315 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80448,7 +80467,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: false content: @@ -80507,12 +80526,12 @@ paths: application/json: schema: type: array - items: *508 + items: *507 examples: - default: *509 - '301': *317 + default: *508 + '301': *315 '404': *6 - '410': *314 + '410': *499 '422': *15 x-github: githubCloudOnly: false @@ -80531,7 +80550,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: false content: @@ -80591,12 +80610,12 @@ paths: application/json: schema: type: array - items: *508 + items: *507 examples: - default: *509 - '301': *317 + default: *508 + '301': *315 '404': *6 - '410': *314 + '410': *499 '422': *15 x-github: githubCloudOnly: false @@ -80615,13 +80634,13 @@ paths: parameters: - *308 - *309 - - *505 + - *504 responses: '204': description: Response - '301': *317 + '301': *315 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80642,7 +80661,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - name: name in: path required: true @@ -80655,7 +80674,7 @@ paths: application/json: schema: type: array - items: *508 + items: *507 examples: default: value: @@ -80666,9 +80685,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *317 + '301': *315 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80690,7 +80709,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: false content: @@ -80719,7 +80738,7 @@ paths: '204': description: Response '403': *27 - '410': *314 + '410': *499 '404': *6 '422': *15 x-github: @@ -80739,7 +80758,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 responses: '204': description: Response @@ -80771,7 +80790,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 responses: '200': description: Response @@ -80779,10 +80798,10 @@ paths: application/json: schema: *78 examples: - default: *504 - '301': *317 + default: *503 + '301': *315 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80801,7 +80820,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - 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. @@ -80833,7 +80852,7 @@ paths: headers: Link: *52 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80853,7 +80872,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: true content: @@ -80918,7 +80937,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - *304 responses: '204': @@ -80950,7 +80969,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: true content: @@ -80974,7 +80993,7 @@ paths: application/json: schema: *78 examples: - default: *504 + default: *503 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -81009,7 +81028,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - *17 - *19 responses: @@ -81021,11 +81040,11 @@ paths: type: array items: *78 examples: - default: *507 + default: *506 headers: Link: *52 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81055,7 +81074,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: true content: @@ -81084,14 +81103,14 @@ paths: application/json: schema: *78 examples: - default: *504 + default: *503 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *314 + '410': *499 '422': *15 '404': *6 x-github: @@ -81113,7 +81132,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 requestBody: required: true content: @@ -81146,7 +81165,7 @@ paths: application/json: schema: *78 examples: - default: *504 + default: *503 '403': *27 '404': *6 '422': *7 @@ -81170,7 +81189,7 @@ paths: parameters: - *308 - *309 - - *505 + - *504 - *17 - *19 responses: @@ -81185,6 +81204,7 @@ paths: description: Timeline Event type: object anyOf: + - *509 - *510 - *511 - *512 @@ -81197,7 +81217,6 @@ paths: - *519 - *520 - *521 - - *522 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -81526,7 +81545,7 @@ paths: type: string comments: type: array - items: &543 + items: &542 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -81764,7 +81783,7 @@ paths: type: string comments: type: array - items: *437 + items: *435 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -82039,7 +82058,7 @@ paths: headers: Link: *52 '404': *6 - '410': *314 + '410': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82067,7 +82086,7 @@ paths: application/json: schema: type: array - items: &523 + items: &522 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -82172,9 +82191,9 @@ paths: description: Response content: application/json: - schema: *523 + schema: *522 examples: - default: &524 + default: &523 value: id: 1 key: ssh-rsa AAA... @@ -82210,7 +82229,7 @@ paths: parameters: - *308 - *309 - - &525 + - &524 name: key_id description: The unique identifier of the key. in: path @@ -82222,9 +82241,9 @@ paths: description: Response content: application/json: - schema: *523 + schema: *522 examples: - default: *524 + default: *523 '404': *6 x-github: githubCloudOnly: false @@ -82244,7 +82263,7 @@ paths: parameters: - *308 - *309 - - *525 + - *524 responses: '204': description: Response @@ -82275,9 +82294,9 @@ paths: application/json: schema: type: array - items: *508 + items: *507 examples: - default: *509 + default: *508 headers: Link: *52 '404': *6 @@ -82335,9 +82354,9 @@ paths: description: Response content: application/json: - schema: *508 + schema: *507 examples: - default: &526 + default: &525 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -82381,9 +82400,9 @@ paths: description: Response content: application/json: - schema: *508 + schema: *507 examples: - default: *526 + default: *525 '404': *6 x-github: githubCloudOnly: false @@ -82440,7 +82459,7 @@ paths: description: Response content: application/json: - schema: *508 + schema: *507 examples: default: value: @@ -82535,7 +82554,7 @@ paths: parameters: - *308 - *309 - - *415 + - *413 responses: '200': description: Response @@ -82783,9 +82802,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *438 + schema: *436 examples: - default: *527 + default: *526 '204': description: Response when already merged '404': @@ -82951,7 +82970,7 @@ paths: application/json: schema: *243 examples: - default: &528 + default: &527 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -83012,7 +83031,7 @@ paths: parameters: - *308 - *309 - - &529 + - &528 name: milestone_number description: The number that identifies the milestone. in: path @@ -83026,7 +83045,7 @@ paths: application/json: schema: *243 examples: - default: *528 + default: *527 '404': *6 x-github: githubCloudOnly: false @@ -83045,7 +83064,7 @@ paths: parameters: - *308 - *309 - - *529 + - *528 requestBody: required: false content: @@ -83085,7 +83104,7 @@ paths: application/json: schema: *243 examples: - default: *528 + default: *527 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83103,7 +83122,7 @@ paths: parameters: - *308 - *309 - - *529 + - *528 responses: '204': description: Response @@ -83126,7 +83145,7 @@ paths: parameters: - *308 - *309 - - *529 + - *528 - *17 - *19 responses: @@ -83136,9 +83155,9 @@ paths: application/json: schema: type: array - items: *508 + items: *507 examples: - default: *509 + default: *508 headers: Link: *52 x-github: @@ -83159,10 +83178,10 @@ paths: parameters: - *308 - *309 + - *529 - *530 - - *531 - *68 - - *532 + - *531 - *17 - *19 responses: @@ -83174,7 +83193,7 @@ paths: type: array items: *90 examples: - default: *533 + default: *532 headers: Link: *52 x-github: @@ -83264,7 +83283,7 @@ paths: description: Response content: application/json: - schema: &534 + schema: &533 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -83408,7 +83427,7 @@ paths: - custom_404 - public examples: - default: &535 + default: &534 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -83505,9 +83524,9 @@ paths: description: Response content: application/json: - schema: *534 + schema: *533 examples: - default: *535 + default: *534 '422': *15 '409': *45 x-github: @@ -83669,7 +83688,7 @@ paths: application/json: schema: type: array - items: &536 + items: &535 title: Page Build description: Page Build type: object @@ -83816,9 +83835,9 @@ paths: description: Response content: application/json: - schema: *536 + schema: *535 examples: - default: &537 + default: &536 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -83878,9 +83897,9 @@ paths: description: Response content: application/json: - schema: *536 + schema: *535 examples: - default: *537 + default: *536 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84011,7 +84030,7 @@ paths: parameters: - *308 - *309 - - &538 + - &537 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -84071,9 +84090,9 @@ paths: parameters: - *308 - *309 - - *538 + - *537 responses: - '204': *165 + '204': *166 '404': *6 x-github: githubCloudOnly: false @@ -84367,7 +84386,7 @@ paths: description: Empty response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -84435,7 +84454,7 @@ paths: - *308 - *309 responses: - '204': *165 + '204': *166 '422': *14 x-github: githubCloudOnly: false @@ -84457,155 +84476,13 @@ paths: - *308 - *309 responses: - '204': *165 + '204': *166 '422': *14 x-github: githubCloudOnly: false enabledForGitHubApps: true category: repos subcategory: repos - "/repos/{owner}/{repo}/projects": - get: - summary: List repository 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: - - projects-classic - operationId: projects-classic/list-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#list-repository-projects - parameters: - - *308 - - *309 - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *238 - examples: - default: - value: - - owner_url: https://api.github.com/repos/api-playground/projects-test - url: https://api.github.com/projects/1002604 - html_url: https://github.com/api-playground/projects-test/projects/1 - columns_url: https://api.github.com/projects/1002604/columns - id: 1002604 - node_id: MDc6UHJvamVjdDEwMDI2MDQ= - name: Projects Documentation - body: Developer documentation project for the developer site. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - headers: - Link: *52 - '401': *23 - '403': *27 - '404': *6 - '410': *314 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create a repository 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: - - projects-classic - operationId: projects-classic/create-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#create-a-repository-project - parameters: - - *308 - - *309 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the project. - body: - type: string - description: The description of the project. - required: - - name - examples: - default: - value: - name: Projects Documentation - body: Developer documentation project for the developer site. - responses: - '201': - description: Response - content: - application/json: - schema: *238 - examples: - default: *313 - '401': *23 - '403': *27 - '404': *6 - '410': *314 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/repos/{owner}/{repo}/properties/values": get: summary: Get all custom property values for a repository @@ -84630,7 +84507,7 @@ paths: type: array items: *95 examples: - default: *539 + default: *538 '403': *27 '404': *6 x-github: @@ -84669,7 +84546,7 @@ paths: required: - properties examples: - default: *540 + default: *539 responses: '204': description: No Content when custom property values are successfully created @@ -84768,9 +84645,9 @@ paths: application/json: schema: type: array - items: *442 + items: *440 examples: - default: *541 + default: *540 headers: Link: *52 '304': *35 @@ -84870,7 +84747,7 @@ paths: description: Response content: application/json: - schema: &545 + schema: &544 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -85054,7 +84931,7 @@ paths: type: - array - 'null' - items: *220 + items: *221 head: type: object properties: @@ -85110,7 +84987,7 @@ paths: - review_comment - self author_association: *65 - auto_merge: *542 + auto_merge: *541 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -85212,7 +85089,7 @@ paths: - merged_by - review_comments examples: - default: &546 + default: &545 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -85769,9 +85646,9 @@ paths: application/json: schema: type: array - items: *543 + items: *542 examples: - default: &548 + default: &547 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -85856,9 +85733,9 @@ paths: description: Response content: application/json: - schema: *543 + schema: *542 examples: - default: &544 + default: &543 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -85957,9 +85834,9 @@ paths: description: Response content: application/json: - schema: *543 + schema: *542 examples: - default: *544 + default: *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86162,7 +86039,7 @@ paths: parameters: - *308 - *309 - - &547 + - &546 name: pull_number description: The number that identifies the pull request. in: path @@ -86175,9 +86052,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *545 + schema: *544 examples: - default: *546 + default: *545 '304': *35 '404': *6 '406': @@ -86214,7 +86091,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 requestBody: required: false content: @@ -86256,9 +86133,9 @@ paths: description: Response content: application/json: - schema: *545 + schema: *544 examples: - default: *546 + default: *545 '422': *15 '403': *27 x-github: @@ -86282,7 +86159,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 requestBody: required: true content: @@ -86343,17 +86220,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '401': *23 '403': *27 '404': *6 @@ -86385,7 +86262,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 - *87 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -86406,9 +86283,9 @@ paths: application/json: schema: type: array - items: *543 + items: *542 examples: - default: *548 + default: *547 headers: Link: *52 x-github: @@ -86443,7 +86320,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 requestBody: required: true content: @@ -86549,7 +86426,7 @@ paths: description: Response content: application/json: - schema: *543 + schema: *542 examples: example-for-a-multi-line-comment: value: @@ -86639,7 +86516,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 - *77 requestBody: required: true @@ -86662,7 +86539,7 @@ paths: description: Response content: application/json: - schema: *543 + schema: *542 examples: default: value: @@ -86750,7 +86627,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 - *17 - *19 responses: @@ -86760,9 +86637,9 @@ paths: application/json: schema: type: array - items: *438 + items: *436 examples: - default: *549 + default: *548 headers: Link: *52 x-github: @@ -86794,7 +86671,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 - *17 - *19 responses: @@ -86804,7 +86681,7 @@ paths: application/json: schema: type: array - items: *449 + items: *447 examples: default: value: @@ -86844,7 +86721,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 responses: '204': description: Response if pull request has been merged @@ -86869,7 +86746,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 requestBody: required: false content: @@ -86983,7 +86860,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 responses: '200': description: Response @@ -86999,7 +86876,7 @@ paths: items: *4 teams: type: array - items: *169 + items: *170 required: - users - teams @@ -87060,7 +86937,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 requestBody: required: false content: @@ -87097,7 +86974,7 @@ paths: description: Response content: application/json: - schema: *442 + schema: *440 examples: default: value: @@ -87635,7 +87512,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 requestBody: required: true content: @@ -87669,7 +87546,7 @@ paths: description: Response content: application/json: - schema: *442 + schema: *440 examples: default: value: @@ -88176,7 +88053,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 - *17 - *19 responses: @@ -88186,7 +88063,7 @@ paths: application/json: schema: type: array - items: &550 + items: &549 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -88344,7 +88221,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 requestBody: required: false content: @@ -88434,9 +88311,9 @@ paths: description: Response content: application/json: - schema: *550 + schema: *549 examples: - default: &552 + default: &551 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -88501,8 +88378,8 @@ paths: parameters: - *308 - *309 - - *547 - - &551 + - *546 + - &550 name: review_id description: The unique identifier of the review. in: path @@ -88514,9 +88391,9 @@ paths: description: Response content: application/json: - schema: *550 + schema: *549 examples: - default: &553 + default: &552 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -88577,8 +88454,8 @@ paths: parameters: - *308 - *309 - - *547 - - *551 + - *546 + - *550 requestBody: required: true content: @@ -88601,7 +88478,7 @@ paths: description: Response content: application/json: - schema: *550 + schema: *549 examples: default: value: @@ -88665,16 +88542,16 @@ paths: parameters: - *308 - *309 - - *547 - - *551 + - *546 + - *550 responses: '200': description: Response content: application/json: - schema: *550 + schema: *549 examples: - default: *552 + default: *551 '422': *7 '404': *6 x-github: @@ -88703,8 +88580,8 @@ paths: parameters: - *308 - *309 - - *547 - - *551 + - *546 + - *550 - *17 - *19 responses: @@ -88964,8 +88841,8 @@ paths: parameters: - *308 - *309 - - *547 - - *551 + - *546 + - *550 requestBody: required: true content: @@ -88994,7 +88871,7 @@ paths: description: Response content: application/json: - schema: *550 + schema: *549 examples: default: value: @@ -89059,8 +88936,8 @@ paths: parameters: - *308 - *309 - - *547 - - *551 + - *546 + - *550 requestBody: required: true content: @@ -89095,9 +88972,9 @@ paths: description: Response content: application/json: - schema: *550 + schema: *549 examples: - default: *553 + default: *552 '404': *6 '422': *7 '403': *27 @@ -89121,7 +88998,7 @@ paths: parameters: - *308 - *309 - - *547 + - *546 requestBody: required: false content: @@ -89199,9 +89076,9 @@ paths: description: Response content: application/json: - schema: *554 + schema: *553 examples: - default: &555 + default: &554 value: type: file encoding: base64 @@ -89264,9 +89141,9 @@ paths: description: Response content: application/json: - schema: *554 + schema: *553 examples: - default: *555 + default: *554 '404': *6 '422': *15 x-github: @@ -89299,7 +89176,7 @@ paths: application/json: schema: type: array - items: &556 + items: &555 title: Release description: A release. type: object @@ -89381,7 +89258,7 @@ paths: author: *4 assets: type: array - items: &557 + items: &556 title: Release Asset description: Data related to a release. type: object @@ -89645,9 +89522,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *555 examples: - default: &560 + default: &559 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -89754,7 +89631,7 @@ paths: parameters: - *308 - *309 - - &558 + - &557 name: asset_id description: The unique identifier of the asset. in: path @@ -89766,9 +89643,9 @@ paths: description: Response content: application/json: - schema: *557 + schema: *556 examples: - default: &559 + default: &558 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -89803,7 +89680,7 @@ paths: type: User site_admin: false '404': *6 - '302': *451 + '302': *449 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89821,7 +89698,7 @@ paths: parameters: - *308 - *309 - - *558 + - *557 requestBody: required: false content: @@ -89850,9 +89727,9 @@ paths: description: Response content: application/json: - schema: *557 + schema: *556 examples: - default: *559 + default: *558 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89870,7 +89747,7 @@ paths: parameters: - *308 - *309 - - *558 + - *557 responses: '204': description: Response @@ -89988,9 +89865,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *555 examples: - default: *560 + default: *559 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90021,9 +89898,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *555 examples: - default: *560 + default: *559 '404': *6 x-github: githubCloudOnly: false @@ -90047,7 +89924,7 @@ paths: parameters: - *308 - *309 - - &561 + - &560 name: release_id description: The unique identifier of the release. in: path @@ -90061,9 +89938,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: *556 + schema: *555 examples: - default: *560 + default: *559 '401': description: Unauthorized x-github: @@ -90083,7 +89960,7 @@ paths: parameters: - *308 - *309 - - *561 + - *560 requestBody: required: false content: @@ -90147,9 +90024,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *555 examples: - default: *560 + default: *559 '404': description: Not Found if the discussion category name is invalid content: @@ -90172,7 +90049,7 @@ paths: parameters: - *308 - *309 - - *561 + - *560 responses: '204': description: Response @@ -90194,7 +90071,7 @@ paths: parameters: - *308 - *309 - - *561 + - *560 - *17 - *19 responses: @@ -90204,7 +90081,7 @@ paths: application/json: schema: type: array - items: *557 + items: *556 examples: default: value: @@ -90287,7 +90164,7 @@ paths: parameters: - *308 - *309 - - *561 + - *560 - name: name in: query required: true @@ -90313,7 +90190,7 @@ paths: description: Response for successful upload content: application/json: - schema: *557 + schema: *556 examples: response-for-successful-upload: value: @@ -90370,7 +90247,7 @@ paths: parameters: - *308 - *309 - - *561 + - *560 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -90419,7 +90296,7 @@ paths: parameters: - *308 - *309 - - *561 + - *560 requestBody: required: true content: @@ -90482,7 +90359,7 @@ paths: parameters: - *308 - *309 - - *561 + - *560 - *304 responses: '204': @@ -90509,7 +90386,7 @@ paths: parameters: - *308 - *309 - - *378 + - *376 - *17 - *19 responses: @@ -90526,7 +90403,7 @@ paths: oneOf: - allOf: - *260 - - &562 + - &561 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -90547,67 +90424,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *261 - - *562 + - *561 - allOf: - *262 - - *562 + - *561 - allOf: - *263 - - *562 + - *561 - allOf: - - *563 - *562 + - *561 - allOf: - *264 - - *562 + - *561 - allOf: - *265 - - *562 + - *561 - allOf: - *266 - - *562 + - *561 - allOf: - *267 - - *562 + - *561 - allOf: - *268 - - *562 + - *561 - allOf: - *269 - - *562 + - *561 - allOf: - *270 - - *562 + - *561 - allOf: - *271 - - *562 + - *561 - allOf: - *272 - - *562 + - *561 - allOf: - *273 - - *562 + - *561 - allOf: - *274 - - *562 + - *561 - allOf: - *275 - - *562 + - *561 - allOf: - *276 - - *562 + - *561 - allOf: - *277 - - *562 + - *561 - allOf: - *278 - - *562 + - *561 - allOf: - *279 - - *562 + - *561 - allOf: - - *564 - - *562 + - *563 + - *561 examples: default: value: @@ -90658,7 +90535,7 @@ paths: schema: type: boolean default: true - - *565 + - *564 responses: '200': description: Response @@ -90743,7 +90620,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *566 + items: *565 required: - name - enforcement @@ -90776,7 +90653,7 @@ paths: application/json: schema: *280 examples: - default: &576 + default: &575 value: id: 42 name: super cool ruleset @@ -90825,10 +90702,10 @@ paths: parameters: - *308 - *309 + - *566 - *567 - *568 - *569 - - *570 - *17 - *19 responses: @@ -90836,9 +90713,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *570 examples: - default: *572 + default: *571 '404': *6 '500': *96 x-github: @@ -90861,15 +90738,15 @@ paths: parameters: - *308 - *309 - - *573 + - *572 responses: '200': description: Response content: application/json: - schema: *574 + schema: *573 examples: - default: *575 + default: *574 '404': *6 '500': *96 x-github: @@ -90920,7 +90797,7 @@ paths: application/json: schema: *280 examples: - default: *576 + default: *575 '404': *6 '500': *96 put: @@ -90973,7 +90850,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *566 + items: *565 examples: default: value: @@ -91003,7 +90880,7 @@ paths: application/json: schema: *280 examples: - default: *576 + default: *575 '404': *6 '500': *96 delete: @@ -91064,7 +90941,7 @@ paths: type: array items: *283 examples: - default: *577 + default: *576 '404': *6 '500': *96 x-github: @@ -91102,7 +90979,7 @@ paths: description: Response content: application/json: - schema: *578 + schema: *577 examples: default: value: @@ -91159,19 +91036,19 @@ paths: parameters: - *308 - *309 + - *578 - *579 - *580 - *581 - - *582 - *46 - *19 - *17 + - *582 - *583 - *584 - *585 - *586 - *587 - - *588 responses: '200': description: Response @@ -91179,24 +91056,24 @@ paths: application/json: schema: type: array - items: &592 + items: &591 type: object properties: - number: *151 - created_at: *152 + number: *152 + created_at: *153 updated_at: anyOf: - type: 'null' - - *153 - url: *154 - html_url: *155 + - *154 + url: *155 + html_url: *156 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *589 - resolution: *590 + state: *588 + resolution: *589 resolved_at: type: - string @@ -91290,7 +91167,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *591 + - *590 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -91437,14 +91314,14 @@ paths: parameters: - *308 - *309 - - *409 - - *588 + - *407 + - *587 responses: '200': description: Response content: application/json: - schema: *592 + schema: *591 examples: default: value: @@ -91498,7 +91375,7 @@ paths: parameters: - *308 - *309 - - *409 + - *407 requestBody: required: true content: @@ -91506,16 +91383,17 @@ paths: schema: type: object properties: - state: *589 - resolution: *590 + state: *588 + resolution: *589 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: - string - 'null' - required: - - state + anyOf: + - required: + - state examples: default: value: @@ -91526,7 +91404,7 @@ paths: description: Response content: application/json: - schema: *592 + schema: *591 examples: default: value: @@ -91603,7 +91481,7 @@ paths: parameters: - *308 - *309 - - *409 + - *407 - *19 - *17 responses: @@ -91614,7 +91492,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &745 + items: &744 type: object properties: type: @@ -91641,6 +91519,7 @@ paths: - commit details: oneOf: + - *592 - *593 - *594 - *595 @@ -91653,7 +91532,6 @@ paths: - *602 - *603 - *604 - - *605 examples: default: value: @@ -91748,14 +91626,14 @@ paths: schema: type: object properties: - reason: &607 + reason: &606 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *606 + placeholder_id: *605 required: - reason - placeholder_id @@ -91772,7 +91650,7 @@ paths: schema: type: object properties: - reason: *607 + reason: *606 expire_at: type: - string @@ -91835,7 +91713,7 @@ paths: properties: incremental_scans: type: array - items: &608 + items: &607 description: Information on a single scan performed by secret scanning on the repository type: object @@ -91863,15 +91741,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *608 + items: *607 backfill_scans: type: array - items: *608 + items: *607 custom_pattern_backfill_scans: type: array items: allOf: - - *608 + - *607 - type: object properties: pattern_name: @@ -91986,9 +91864,9 @@ paths: application/json: schema: type: array - items: *609 + items: *608 examples: - default: *610 + default: *609 '400': *14 '404': *6 x-github: @@ -92182,9 +92060,9 @@ paths: description: Response content: application/json: - schema: *609 + schema: *608 examples: - default: &612 + default: &611 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -92531,7 +92409,7 @@ paths: description: Response content: application/json: - schema: *609 + schema: *608 examples: default: value: @@ -92680,15 +92558,15 @@ paths: parameters: - *308 - *309 - - *611 + - *610 responses: '200': description: Response content: application/json: - schema: *609 + schema: *608 examples: - default: *612 + default: *611 '403': *27 '404': *6 x-github: @@ -92714,7 +92592,7 @@ paths: parameters: - *308 - *309 - - *611 + - *610 requestBody: required: true content: @@ -92885,17 +92763,17 @@ paths: description: Response content: application/json: - schema: *609 + schema: *608 examples: - default: *612 - add_credit: *612 + default: *611 + add_credit: *611 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *104 + schema: *105 examples: invalid_state_transition: value: @@ -92928,7 +92806,7 @@ paths: parameters: - *308 - *309 - - *611 + - *610 responses: '202': *37 '400': *14 @@ -92957,15 +92835,15 @@ paths: parameters: - *308 - *309 - - *611 + - *610 responses: '202': description: Response content: application/json: - schema: *316 + schema: *314 examples: - default: *318 + default: *316 '400': *14 '422': *15 '403': *27 @@ -93098,7 +92976,7 @@ paths: application/json: schema: type: array - items: &613 + items: &612 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -93111,7 +92989,7 @@ paths: - 1124 - -435 '202': *37 - '204': *165 + '204': *166 '422': description: Repository contains more than 10,000 commits x-github: @@ -93183,7 +93061,7 @@ paths: total: 89 week: 1336280400 '202': *37 - '204': *165 + '204': *166 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93283,7 +93161,7 @@ paths: d: 77 c: 10 '202': *37 - '204': *165 + '204': *166 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93471,7 +93349,7 @@ paths: application/json: schema: type: array - items: *613 + items: *612 examples: default: value: @@ -93484,7 +93362,7 @@ paths: - - 0 - 2 - 21 - '204': *165 + '204': *166 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93561,7 +93439,7 @@ paths: description: Response content: application/json: - schema: *614 + schema: *613 examples: default: value: @@ -93655,7 +93533,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &615 + schema: &614 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -93755,7 +93633,7 @@ paths: description: Response content: application/json: - schema: *615 + schema: *614 examples: default: value: @@ -93895,7 +93773,7 @@ paths: application/json: schema: type: array - items: &616 + items: &615 title: Tag protection description: Tag protection type: object @@ -93976,7 +93854,7 @@ paths: description: Response content: application/json: - schema: *616 + schema: *615 examples: default: value: @@ -94093,9 +93971,9 @@ paths: application/json: schema: type: array - items: *169 + items: *170 examples: - default: *221 + default: *222 headers: Link: *52 '404': *6 @@ -94124,7 +94002,7 @@ paths: description: Response content: application/json: - schema: &617 + schema: &616 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -94136,7 +94014,7 @@ paths: required: - names examples: - default: &618 + default: &617 value: names: - octocat @@ -94191,9 +94069,9 @@ paths: description: Response content: application/json: - schema: *617 + schema: *616 examples: - default: *618 + default: *617 '404': *6 '422': *7 x-github: @@ -94216,7 +94094,7 @@ paths: parameters: - *308 - *309 - - &619 + - &618 name: per description: The time frame to display results for. in: query @@ -94247,7 +94125,7 @@ paths: - 128 clones: type: array - items: &620 + items: &619 title: Traffic type: object properties: @@ -94495,7 +94373,7 @@ paths: parameters: - *308 - *309 - - *619 + - *618 responses: '200': description: Response @@ -94516,7 +94394,7 @@ paths: - 3782 views: type: array - items: *620 + items: *619 required: - uniques - count @@ -94630,7 +94508,7 @@ paths: description: Response content: application/json: - schema: *135 + schema: *136 examples: default: value: @@ -95035,9 +94913,9 @@ paths: description: Response content: application/json: - schema: *316 + schema: *314 examples: - default: *318 + default: *316 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -95078,7 +94956,7 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: default: value: @@ -95267,7 +95145,7 @@ paths: html_url: type: string format: uri - repository: *135 + repository: *136 score: type: number file_size: @@ -95286,7 +95164,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &621 + text_matches: &620 title: Search Result Text Matches type: array items: @@ -95449,7 +95327,7 @@ paths: enum: - author-date - committer-date - - &622 + - &621 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -95518,7 +95396,7 @@ paths: committer: anyOf: - type: 'null' - - *376 + - *374 comment_count: type: integer message: @@ -95537,7 +95415,7 @@ paths: url: type: string format: uri - verification: *487 + verification: *485 required: - author - committer @@ -95552,7 +95430,7 @@ paths: committer: anyOf: - type: 'null' - - *376 + - *374 parents: type: array items: @@ -95564,12 +95442,12 @@ paths: type: string sha: type: string - repository: *135 + repository: *136 score: type: number node_id: type: string - text_matches: *621 + text_matches: *620 required: - sha - node_id @@ -95761,7 +95639,7 @@ paths: - interactions - created - updated - - *622 + - *621 - *17 - *19 - name: advanced_search @@ -95858,11 +95736,11 @@ paths: type: - string - 'null' - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: type: string state_reason: @@ -95890,7 +95768,7 @@ paths: - string - 'null' format: date-time - text_matches: *621 + text_matches: *620 pull_request: type: object properties: @@ -95939,7 +95817,7 @@ paths: timeline_url: type: string format: uri - type: *205 + type: *206 performed_via_github_app: anyOf: - type: 'null' @@ -96113,7 +95991,7 @@ paths: enum: - created - updated - - *622 + - *621 - *17 - *19 responses: @@ -96158,7 +96036,7 @@ paths: - 'null' score: type: number - text_matches: *621 + text_matches: *620 required: - id - node_id @@ -96243,7 +96121,7 @@ paths: - forks - help-wanted-issues - updated - - *622 + - *621 - *17 - *19 responses: @@ -96480,7 +96358,7 @@ paths: - admin - pull - push - text_matches: *621 + text_matches: *620 temp_clone_token: type: string allow_merge_commit: @@ -96788,7 +96666,7 @@ paths: - string - 'null' format: uri - text_matches: *621 + text_matches: *620 related: type: - array @@ -96981,7 +96859,7 @@ paths: - followers - repositories - joined - - *622 + - *621 - *17 - *19 responses: @@ -97091,7 +96969,7 @@ paths: type: - boolean - 'null' - text_matches: *621 + text_matches: *620 blog: type: - string @@ -97173,7 +97051,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &626 + - &625 name: team_id description: The unique identifier of the team. in: path @@ -97214,7 +97092,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *626 + - *625 requestBody: required: true content: @@ -97315,7 +97193,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *626 + - *625 responses: '204': description: Response @@ -97346,7 +97224,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *626 + - *625 - *46 - *17 - *19 @@ -97359,7 +97237,7 @@ paths: type: array items: *295 examples: - default: *627 + default: *626 headers: Link: *52 x-github: @@ -97388,7 +97266,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *626 + - *625 requestBody: required: true content: @@ -97451,7 +97329,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *626 + - *625 - *297 responses: '200': @@ -97485,7 +97363,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *626 + - *625 - *297 requestBody: required: false @@ -97511,7 +97389,7 @@ paths: application/json: schema: *295 examples: - default: *628 + default: *627 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97536,7 +97414,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *626 + - *625 - *297 responses: '204': @@ -97566,7 +97444,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *626 + - *625 - *297 - *46 - *17 @@ -97580,7 +97458,7 @@ paths: type: array items: *298 examples: - default: *629 + default: *628 headers: Link: *52 x-github: @@ -97609,7 +97487,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *626 + - *625 - *297 requestBody: required: true @@ -97661,7 +97539,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *626 + - *625 - *297 - *300 responses: @@ -97696,7 +97574,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *626 + - *625 - *297 - *300 requestBody: @@ -97722,7 +97600,7 @@ paths: application/json: schema: *298 examples: - default: *630 + default: *629 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97747,7 +97625,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *626 + - *625 - *297 - *300 responses: @@ -97778,7 +97656,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *626 + - *625 - *297 - *300 - name: content @@ -97837,7 +97715,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *626 + - *625 - *297 - *300 requestBody: @@ -97899,7 +97777,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *626 + - *625 - *297 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -97957,7 +97835,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *626 + - *625 - *297 requestBody: required: true @@ -98016,7 +97894,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *626 + - *625 - *17 - *19 responses: @@ -98026,9 +97904,9 @@ paths: application/json: schema: type: array - items: *202 + items: *203 examples: - default: *203 + default: *204 headers: Link: *52 x-github: @@ -98054,7 +97932,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *626 + - *625 - name: role description: Filters members returned by their role in the team. in: query @@ -98105,7 +97983,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *626 + - *625 - *57 responses: '204': @@ -98142,7 +98020,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *626 + - *625 - *57 responses: '204': @@ -98182,7 +98060,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *626 + - *625 - *57 responses: '204': @@ -98219,7 +98097,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *626 + - *625 - *57 responses: '200': @@ -98228,7 +98106,7 @@ paths: application/json: schema: *305 examples: - response-if-user-is-a-team-maintainer: *631 + response-if-user-is-a-team-maintainer: *630 '404': *6 x-github: githubCloudOnly: false @@ -98261,7 +98139,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *626 + - *625 - *57 requestBody: required: false @@ -98289,7 +98167,7 @@ paths: application/json: schema: *305 examples: - response-if-users-membership-with-team-is-now-pending: *632 + response-if-users-membership-with-team-is-now-pending: *631 '403': description: Forbidden if team synchronization is set up '422': @@ -98323,7 +98201,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *626 + - *625 - *57 responses: '204': @@ -98352,7 +98230,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *626 + - *625 - *17 - *19 responses: @@ -98364,7 +98242,7 @@ paths: type: array items: *306 examples: - default: *633 + default: *632 headers: Link: *52 '404': *6 @@ -98390,7 +98268,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *626 + - *625 - *307 responses: '200': @@ -98399,7 +98277,7 @@ paths: application/json: schema: *306 examples: - default: *634 + default: *633 '404': description: Not Found if project is not managed by this team x-github: @@ -98423,7 +98301,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *626 + - *625 - *307 requestBody: required: false @@ -98491,7 +98369,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *626 + - *625 - *307 responses: '204': @@ -98519,7 +98397,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *626 + - *625 - *17 - *19 responses: @@ -98529,9 +98407,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: *228 + default: *229 headers: Link: *52 '404': *6 @@ -98561,7 +98439,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *626 + - *625 - *308 - *309 responses: @@ -98569,7 +98447,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *635 + schema: *634 examples: alternative-response-with-extra-repository-information: value: @@ -98720,7 +98598,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *626 + - *625 - *308 - *309 requestBody: @@ -98772,7 +98650,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *626 + - *625 - *308 - *309 responses: @@ -98799,7 +98677,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *626 + - *625 - *17 - *19 responses: @@ -98809,9 +98687,9 @@ paths: application/json: schema: type: array - items: *169 + items: *170 examples: - response-if-child-teams-exist: *636 + response-if-child-teams-exist: *635 headers: Link: *52 '404': *6 @@ -98844,7 +98722,7 @@ paths: application/json: schema: oneOf: - - &638 + - &637 title: Private User description: Private User type: object @@ -99094,7 +98972,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *637 + - *636 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -99254,7 +99132,7 @@ paths: description: Response content: application/json: - schema: *638 + schema: *637 examples: default: value: @@ -99457,9 +99335,9 @@ paths: type: integer codespaces: type: array - items: *210 + items: *211 examples: - default: *211 + default: *212 '304': *35 '500': *96 '401': *23 @@ -99598,17 +99476,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '401': *23 '403': *27 '404': *6 @@ -99652,7 +99530,7 @@ paths: type: integer secrets: type: array - items: &639 + items: &638 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -99694,7 +99572,7 @@ paths: - visibility - selected_repositories_url examples: - default: *431 + default: *429 headers: Link: *52 x-github: @@ -99766,13 +99644,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *143 + - *144 responses: '200': description: Response content: application/json: - schema: *639 + schema: *638 examples: default: value: @@ -99802,7 +99680,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *143 + - *144 requestBody: required: true content: @@ -99847,7 +99725,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -99875,7 +99753,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *143 + - *144 responses: '204': description: Response @@ -99900,7 +99778,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *143 + - *144 responses: '200': description: Response @@ -99916,9 +99794,9 @@ paths: type: integer repositories: type: array - items: *135 + items: *136 examples: - default: *640 + default: *639 '401': *23 '403': *27 '404': *6 @@ -99943,7 +99821,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *143 + - *144 requestBody: required: true content: @@ -99997,7 +99875,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *143 + - *144 - name: repository_id in: path required: true @@ -100030,7 +99908,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *143 + - *144 - name: repository_id in: path required: true @@ -100062,15 +99940,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *212 + - *213 responses: '200': description: Response content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '304': *35 '500': *96 '401': *23 @@ -100096,7 +99974,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *212 + - *213 requestBody: required: false content: @@ -100126,9 +100004,9 @@ paths: description: Response content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '401': *23 '403': *27 '404': *6 @@ -100150,7 +100028,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *212 + - *213 responses: '202': *37 '304': *35 @@ -100179,13 +100057,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *212 + - *213 responses: '202': description: Response content: application/json: - schema: &641 + schema: &640 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -100238,7 +100116,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &642 + default: &641 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -100270,7 +100148,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *212 + - *213 - name: export_id in: path required: true @@ -100283,9 +100161,9 @@ paths: description: Response content: application/json: - schema: *641 + schema: *640 examples: - default: *642 + default: *641 '404': *6 x-github: githubCloudOnly: false @@ -100306,7 +100184,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *212 + - *213 responses: '200': description: Response @@ -100322,9 +100200,9 @@ paths: type: integer machines: type: array - items: *430 + items: *428 examples: - default: *643 + default: *642 '304': *35 '500': *96 '401': *23 @@ -100353,7 +100231,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *212 + - *213 requestBody: required: true content: @@ -100409,11 +100287,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *316 + repository: *314 machine: anyOf: - type: 'null' - - *430 + - *428 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -101210,15 +101088,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *212 + - *213 responses: '200': description: Response content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '304': *35 '500': *96 '400': *14 @@ -101250,15 +101128,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *212 + - *213 responses: '200': description: Response content: application/json: - schema: *210 + schema: *211 examples: - default: *429 + default: *427 '500': *96 '401': *23 '403': *27 @@ -101288,9 +101166,9 @@ paths: application/json: schema: type: array - items: *222 + items: *223 examples: - default: &654 + default: &653 value: - id: 197 name: hello_docker @@ -101391,7 +101269,7 @@ paths: application/json: schema: type: array - items: &644 + items: &643 title: Email description: Email type: object @@ -101461,9 +101339,9 @@ paths: application/json: schema: type: array - items: *644 + items: *643 examples: - default: &656 + default: &655 value: - email: octocat@github.com verified: true @@ -101540,7 +101418,7 @@ paths: application/json: schema: type: array - items: *644 + items: *643 examples: default: value: @@ -101798,7 +101676,7 @@ paths: application/json: schema: type: array - items: &645 + items: &644 title: GPG Key description: A unique encryption key type: object @@ -101943,7 +101821,7 @@ paths: - subkeys - revoked examples: - default: &670 + default: &669 value: - id: 3 name: Octocat's GPG Key @@ -102028,9 +101906,9 @@ paths: description: Response content: application/json: - schema: *645 + schema: *644 examples: - default: &646 + default: &645 value: id: 3 name: Octocat's GPG Key @@ -102087,7 +101965,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &647 + - &646 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -102099,9 +101977,9 @@ paths: description: Response content: application/json: - schema: *645 + schema: *644 examples: - default: *646 + default: *645 '404': *6 '304': *35 '403': *27 @@ -102124,7 +102002,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *647 + - *646 responses: '204': description: Response @@ -102315,7 +102193,7 @@ paths: type: array items: *64 examples: - default: *127 + default: *128 headers: Link: *52 '404': *6 @@ -102340,7 +102218,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *124 + - *125 responses: '204': description: Response @@ -102366,7 +102244,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *124 + - *125 responses: '204': description: Response @@ -102400,12 +102278,12 @@ paths: application/json: schema: anyOf: - - *200 + - *201 - type: object properties: {} additionalProperties: false examples: - default: *201 + default: *202 '204': description: Response when there are no restrictions x-github: @@ -102429,7 +102307,7 @@ paths: required: true content: application/json: - schema: *498 + schema: *496 examples: default: value: @@ -102440,7 +102318,7 @@ paths: description: Response content: application/json: - schema: *200 + schema: *201 examples: default: value: @@ -102521,7 +102399,7 @@ paths: - closed - all default: open - - *208 + - *209 - name: sort description: What to sort results by. in: query @@ -102546,7 +102424,7 @@ paths: type: array items: *78 examples: - default: *209 + default: *210 headers: Link: *52 '404': *6 @@ -102579,7 +102457,7 @@ paths: application/json: schema: type: array - items: &648 + items: &647 title: Key description: Key type: object @@ -102682,9 +102560,9 @@ paths: description: Response content: application/json: - schema: *648 + schema: *647 examples: - default: &649 + default: &648 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -102717,15 +102595,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *525 + - *524 responses: '200': description: Response content: application/json: - schema: *648 + schema: *647 examples: - default: *649 + default: *648 '404': *6 '304': *35 '403': *27 @@ -102748,7 +102626,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *525 + - *524 responses: '204': description: Response @@ -102781,7 +102659,7 @@ paths: application/json: schema: type: array - items: &650 + items: &649 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -102860,7 +102738,7 @@ paths: - account - plan examples: - default: &651 + default: &650 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -102922,9 +102800,9 @@ paths: application/json: schema: type: array - items: *650 + items: *649 examples: - default: *651 + default: *650 headers: Link: *52 '304': *35 @@ -102964,7 +102842,7 @@ paths: application/json: schema: type: array - items: *214 + items: *215 examples: default: value: @@ -103072,7 +102950,7 @@ paths: description: Response content: application/json: - schema: *214 + schema: *215 examples: default: value: @@ -103155,7 +103033,7 @@ paths: description: Response content: application/json: - schema: *214 + schema: *215 examples: default: value: @@ -103223,7 +103101,7 @@ paths: application/json: schema: type: array - items: *216 + items: *217 examples: default: value: @@ -103485,7 +103363,7 @@ paths: description: Response content: application/json: - schema: *216 + schema: *217 examples: default: value: @@ -103665,7 +103543,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *217 + - *218 - name: exclude in: query required: false @@ -103678,7 +103556,7 @@ paths: description: Response content: application/json: - schema: *216 + schema: *217 examples: default: value: @@ -103872,7 +103750,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *217 + - *218 responses: '302': description: Response @@ -103898,7 +103776,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *217 + - *218 responses: '204': description: Response @@ -103927,8 +103805,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *217 - - *652 + - *218 + - *651 responses: '204': description: Response @@ -103952,7 +103830,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *217 + - *218 - *17 - *19 responses: @@ -103962,9 +103840,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: *228 + default: *229 headers: Link: *52 '404': *6 @@ -104043,7 +103921,7 @@ paths: - docker - nuget - container - - *653 + - *652 - *19 - *17 responses: @@ -104053,10 +103931,10 @@ paths: application/json: schema: type: array - items: *222 + items: *223 examples: - default: *654 - '400': *655 + default: *653 + '400': *654 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104076,16 +103954,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *224 - *225 + - *226 responses: '200': description: Response content: application/json: - schema: *222 + schema: *223 examples: - default: &671 + default: &670 value: id: 40201 name: octo-name @@ -104198,8 +104076,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *224 - *225 + - *226 responses: '204': description: Response @@ -104229,8 +104107,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *224 - *225 + - *226 - name: token description: package token schema: @@ -104262,8 +104140,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: - - *224 - *225 + - *226 - *19 - *17 - name: state @@ -104283,7 +104161,7 @@ paths: application/json: schema: type: array - items: *226 + items: *227 examples: default: value: @@ -104332,15 +104210,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *224 - *225 - - *227 + - *226 + - *228 responses: '200': description: Response content: application/json: - schema: *226 + schema: *227 examples: default: value: @@ -104376,9 +104254,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *224 - *225 - - *227 + - *226 + - *228 responses: '204': description: Response @@ -104408,9 +104286,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *224 - *225 - - *227 + - *226 + - *228 responses: '204': description: Response @@ -104422,99 +104300,6 @@ paths: enabledForGitHubApps: false category: packages subcategory: packages - "/user/projects": - post: - summary: Create a user 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: - - projects-classic - operationId: projects-classic/create-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#create-a-user-project - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - required: - - name - type: object - examples: - default: - summary: Create a new project - value: - name: My Projects - body: A board to manage my personal projects. - responses: - '201': - description: Response - content: - application/json: - schema: *238 - examples: - default: - value: - owner_url: https://api.github.com/users/octocat - url: https://api.github.com/projects/1002603 - html_url: https://github.com/users/octocat/projects/1 - columns_url: https://api.github.com/projects/1002603/columns - id: 1002603 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - name: My Projects - body: A board to manage my personal projects. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - '304': *35 - '403': *27 - '401': *23 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/user/public_emails": get: summary: List public email addresses for the authenticated user @@ -104540,9 +104325,9 @@ paths: application/json: schema: type: array - items: *644 + items: *643 examples: - default: *656 + default: *655 headers: Link: *52 '304': *35 @@ -104655,7 +104440,7 @@ paths: type: array items: *64 examples: - default: &663 + default: &662 summary: Default response value: - id: 1296269 @@ -104973,9 +104758,9 @@ paths: description: Response content: application/json: - schema: *316 + schema: *314 examples: - default: *318 + default: *316 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -105013,9 +104798,9 @@ paths: application/json: schema: type: array - items: *500 + items: *498 examples: - default: *657 + default: *656 headers: Link: *52 '304': *35 @@ -105038,7 +104823,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *204 + - *205 responses: '204': description: Response @@ -105061,7 +104846,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *204 + - *205 responses: '204': description: Response @@ -105094,7 +104879,7 @@ paths: application/json: schema: type: array - items: &658 + items: &657 title: Social account description: Social media account type: object @@ -105111,7 +104896,7 @@ paths: - provider - url examples: - default: &659 + default: &658 value: - provider: twitter url: https://twitter.com/github @@ -105174,9 +104959,9 @@ paths: application/json: schema: type: array - items: *658 + items: *657 examples: - default: *659 + default: *658 '422': *15 '304': *35 '404': *6 @@ -105264,7 +105049,7 @@ paths: application/json: schema: type: array - items: &660 + items: &659 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -105284,7 +105069,7 @@ paths: - title - created_at examples: - default: &686 + default: &685 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -105351,9 +105136,9 @@ paths: description: Response content: application/json: - schema: *660 + schema: *659 examples: - default: &661 + default: &660 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -105384,7 +105169,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: - - &662 + - &661 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -105396,9 +105181,9 @@ paths: description: Response content: application/json: - schema: *660 + schema: *659 examples: - default: *661 + default: *660 '404': *6 '304': *35 '403': *27 @@ -105421,7 +105206,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: - - *662 + - *661 responses: '204': description: Response @@ -105450,7 +105235,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &687 + - &686 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 @@ -105475,11 +105260,11 @@ paths: type: array items: *64 examples: - default-response: *663 + default-response: *662 application/vnd.github.v3.star+json: schema: type: array - items: &688 + items: &687 title: Starred Repository description: Starred Repository type: object @@ -105723,9 +105508,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: *228 + default: *229 headers: Link: *52 '304': *35 @@ -105848,10 +105633,10 @@ paths: application/json: schema: oneOf: - - *638 - *637 + - *636 examples: - default-response: &665 + default-response: &664 summary: Default response value: login: octocat @@ -105886,7 +105671,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &666 + response-with-git-hub-plan-information: &665 summary: Response with GitHub plan information value: login: octocat @@ -105946,7 +105731,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *664 + - *663 - *17 responses: '200': @@ -105995,11 +105780,11 @@ paths: application/json: schema: oneOf: - - *638 - *637 + - *636 examples: - default-response: *665 - response-with-git-hub-plan-information: *666 + default-response: *664 + response-with-git-hub-plan-information: *665 '404': *6 x-github: githubCloudOnly: false @@ -106049,8 +105834,8 @@ paths: required: - subject_digests examples: - default: *667 - withPredicateType: *668 + default: *666 + withPredicateType: *667 responses: '200': description: Response @@ -106104,7 +105889,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *669 + default: *668 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106309,12 +106094,12 @@ paths: initiator: type: string examples: - default: *372 + default: *370 '201': description: Response content: application/json: - schema: *144 + schema: *145 examples: default: value: @@ -106348,9 +106133,9 @@ paths: application/json: schema: type: array - items: *222 + items: *223 examples: - default: *654 + default: *653 '403': *27 '401': *23 x-github: @@ -106734,9 +106519,9 @@ paths: application/json: schema: type: array - items: *645 + items: *644 examples: - default: *670 + default: *669 headers: Link: *52 x-github: @@ -106840,7 +106625,7 @@ paths: application/json: schema: *20 examples: - default: *497 + default: *495 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106965,7 +106750,7 @@ paths: - docker - nuget - container - - *653 + - *652 - *57 - *19 - *17 @@ -106976,12 +106761,12 @@ paths: application/json: schema: type: array - items: *222 + items: *223 examples: - default: *654 + default: *653 '403': *27 '401': *23 - '400': *655 + '400': *654 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107001,17 +106786,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *224 - *225 + - *226 - *57 responses: '200': description: Response content: application/json: - schema: *222 + schema: *223 examples: - default: *671 + default: *670 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107032,8 +106817,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *224 - *225 + - *226 - *57 responses: '204': @@ -107066,8 +106851,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *224 - *225 + - *226 - *57 - name: token description: package token @@ -107100,8 +106885,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *224 - *225 + - *226 - *57 responses: '200': @@ -107110,7 +106895,7 @@ paths: application/json: schema: type: array - items: *226 + items: *227 examples: default: value: @@ -107168,16 +106953,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *224 - *225 - - *227 + - *226 + - *228 - *57 responses: '200': description: Response content: application/json: - schema: *226 + schema: *227 examples: default: value: @@ -107212,10 +106997,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *224 - *225 + - *226 - *57 - - *227 + - *228 responses: '204': description: Response @@ -107247,10 +107032,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *224 - *225 + - *226 - *57 - - *227 + - *228 responses: '204': description: Response @@ -107262,87 +107047,6 @@ paths: enabledForGitHubApps: false category: packages subcategory: packages - "/users/{username}/projects": - get: - summary: List user 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: - - projects-classic - operationId: projects-classic/list-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/projects#list-user-projects - parameters: - - *57 - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *238 - examples: - default: - value: - - owner_url: https://api.github.com/users/octocat - url: https://api.github.com/projects/1002603 - html_url: https://github.com/users/octocat/projects/1 - columns_url: https://api.github.com/projects/1002603/columns - id: 1002603 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - name: My Projects - body: A board to manage my personal projects. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - headers: - Link: *52 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/users/{username}/projectsV2": get: summary: List projects for user @@ -107441,7 +107145,7 @@ paths: type: array items: *242 examples: - default: *672 + default: *671 headers: Link: *52 '304': *35 @@ -107464,7 +107168,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *241 - - *673 + - *672 - *57 responses: '200': @@ -107473,7 +107177,7 @@ paths: application/json: schema: *242 examples: - default: *674 + default: *673 headers: Link: *52 '304': *35 @@ -107590,7 +107294,7 @@ paths: description: Response content: application/json: - schema: *675 + schema: *674 examples: issue: *246 pull_request: *246 @@ -107979,9 +107683,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: *228 + default: *229 headers: Link: *52 x-github: @@ -108011,9 +107715,9 @@ paths: description: Response content: application/json: - schema: *676 + schema: *675 examples: - default: *677 + default: *676 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108041,9 +107745,9 @@ paths: description: Response content: application/json: - schema: *678 + schema: *677 examples: - default: *679 + default: *678 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108064,11 +107768,11 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-a-user parameters: - *57 - - *98 - - *100 - *99 - - *680 - *101 + - *100 + - *679 + - *102 responses: '200': description: Response when getting a billing premium request usage report @@ -108204,9 +107908,9 @@ paths: description: Response content: application/json: - schema: *681 + schema: *680 examples: - default: *682 + default: *681 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -108227,9 +107931,9 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - *57 - - *98 - - *683 - *99 + - *682 + - *100 responses: '200': description: Response when getting a billing usage report @@ -108308,7 +108012,7 @@ paths: subcategory: enhanced-billing "/users/{username}/settings/billing/usage/summary": get: - summary: Get billing usage summary report for a user + summary: Get billing usage summary for a user description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. @@ -108321,18 +108025,18 @@ paths: operationId: billing/get-github-billing-usage-summary-report-user externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-report-for-a-user + url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-summary-for-a-user parameters: - *57 - - *98 - - *100 - *99 - - *684 - *101 - - *685 + - *100 + - *683 + - *102 + - *684 responses: '200': - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -108463,9 +108167,9 @@ paths: application/json: schema: type: array - items: *658 + items: *657 examples: - default: *659 + default: *658 headers: Link: *52 x-github: @@ -108495,9 +108199,9 @@ paths: application/json: schema: type: array - items: *660 + items: *659 examples: - default: *686 + default: *685 headers: Link: *52 x-github: @@ -108522,7 +108226,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *57 - - *687 + - *686 - *46 - *17 - *19 @@ -108534,11 +108238,11 @@ paths: schema: anyOf: - type: array - items: *688 + items: *687 - type: array items: *64 examples: - default-response: *663 + default-response: *662 headers: Link: *52 x-github: @@ -108567,9 +108271,9 @@ paths: application/json: schema: type: array - items: *135 + items: *136 examples: - default: *228 + default: *229 headers: Link: *52 x-github: @@ -108698,7 +108402,7 @@ webhooks: type: string enum: - disabled - enterprise: &689 + enterprise: &688 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -108767,7 +108471,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &690 + installation: &689 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -108788,7 +108492,7 @@ webhooks: required: - id - node_id - organization: &691 + organization: &690 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -108861,7 +108565,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &692 + repository: &691 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -109774,10 +109478,10 @@ webhooks: type: string enum: - enabled - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -109853,11 +109557,11 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 - rule: &693 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 + rule: &692 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) @@ -110080,11 +109784,11 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 - rule: *693 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 + rule: *692 sender: *4 required: - action @@ -110272,11 +109976,11 @@ webhooks: - everyone required: - from - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 - rule: *693 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 + rule: *692 sender: *4 required: - action @@ -110360,7 +110064,7 @@ webhooks: type: string enum: - completed - check_run: &695 + check_run: &694 title: CheckRun description: A check performed on the code of a given code change type: object @@ -110425,8 +110129,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *389 - repository: *135 + items: *387 + repository: *136 status: type: string enum: @@ -110470,7 +110174,7 @@ webhooks: - examples: - neutral - deployment: *694 + deployment: *693 details_url: type: string examples: @@ -110530,7 +110234,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *389 + items: *387 started_at: type: string format: date-time @@ -110568,10 +110272,10 @@ webhooks: - output - app - pull_requests - installation: *690 - enterprise: *689 - organization: *691 - repository: *692 + installation: *689 + enterprise: *688 + organization: *690 + repository: *691 sender: *4 required: - check_run @@ -110964,11 +110668,11 @@ webhooks: type: string enum: - created - check_run: *695 - installation: *690 - enterprise: *689 - organization: *691 - repository: *692 + check_run: *694 + installation: *689 + enterprise: *688 + organization: *690 + repository: *691 sender: *4 required: - check_run @@ -111364,11 +111068,11 @@ webhooks: type: string enum: - requested_action - check_run: *695 - installation: *690 - enterprise: *689 - organization: *691 - repository: *692 + check_run: *694 + installation: *689 + enterprise: *688 + organization: *690 + repository: *691 requested_action: description: The action requested by the user. type: object @@ -111773,11 +111477,11 @@ webhooks: type: string enum: - rerequested - check_run: *695 - installation: *690 - enterprise: *689 - organization: *691 - repository: *692 + check_run: *694 + installation: *689 + enterprise: *688 + organization: *690 + repository: *691 sender: *4 required: - check_run @@ -112769,10 +112473,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -113457,10 +113161,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -114139,10 +113843,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -114311,7 +114015,7 @@ webhooks: required: - login - id - dismissed_comment: *404 + dismissed_comment: *402 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -114463,20 +114167,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &696 + commit_oid: &695 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: *689 - installation: *690 - organization: *691 - ref: &697 + enterprise: *688 + installation: *689 + organization: *690 + ref: &696 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: *692 + repository: *691 sender: *4 required: - action @@ -114643,7 +114347,7 @@ webhooks: required: - login - id - dismissed_comment: *404 + dismissed_comment: *402 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -114884,12 +114588,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *696 - enterprise: *689 - installation: *690 - organization: *691 - ref: *697 - repository: *692 + commit_oid: *695 + enterprise: *688 + installation: *689 + organization: *690 + ref: *696 + repository: *691 sender: *4 required: - action @@ -114987,7 +114691,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *404 + dismissed_comment: *402 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -115172,12 +114876,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *696 - enterprise: *689 - installation: *690 - organization: *691 - ref: *697 - repository: *692 + commit_oid: *695 + enterprise: *688 + installation: *689 + organization: *690 + ref: *696 + repository: *691 sender: *4 required: - action @@ -115346,7 +115050,7 @@ webhooks: required: - login - id - dismissed_comment: *404 + dismissed_comment: *402 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -115523,12 +115227,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *696 - enterprise: *689 - installation: *690 - organization: *691 - ref: *697 - repository: *692 + commit_oid: *695 + enterprise: *688 + installation: *689 + organization: *690 + ref: *696 + repository: *691 sender: *4 required: - action @@ -115631,7 +115335,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *404 + dismissed_comment: *402 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -115811,9 +115515,9 @@ webhooks: type: - string - 'null' - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -115821,7 +115525,7 @@ webhooks: type: - string - 'null' - repository: *692 + repository: *691 sender: *4 required: - action @@ -115920,7 +115624,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *404 + dismissed_comment: *402 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -116067,12 +115771,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *696 - enterprise: *689 - installation: *690 - organization: *691 - ref: *697 - repository: *692 + commit_oid: *695 + enterprise: *688 + installation: *689 + organization: *690 + ref: *696 + repository: *691 sender: *4 required: - action @@ -116334,10 +116038,10 @@ webhooks: - updated_at - author_association - body - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -116418,18 +116122,18 @@ webhooks: type: - string - 'null' - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *691 - pusher_type: &698 + organization: *690 + pusher_type: &697 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &699 + ref: &698 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -116439,7 +116143,7 @@ webhooks: enum: - tag - branch - repository: *692 + repository: *691 sender: *4 required: - ref @@ -116522,9 +116226,9 @@ webhooks: enum: - created definition: *250 - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 sender: *4 required: - action @@ -116609,9 +116313,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 sender: *4 required: - action @@ -116689,9 +116393,9 @@ webhooks: enum: - promote_to_enterprise definition: *250 - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 sender: *4 required: - action @@ -116769,9 +116473,9 @@ webhooks: enum: - updated definition: *250 - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 sender: *4 required: - action @@ -116848,10 +116552,10 @@ webhooks: type: string enum: - updated - enterprise: *689 - installation: *690 - repository: *692 - organization: *691 + enterprise: *688 + installation: *689 + repository: *691 + organization: *690 sender: *4 new_property_values: type: array @@ -116936,18 +116640,18 @@ webhooks: title: delete event type: object properties: - enterprise: *689 - installation: *690 - organization: *691 - pusher_type: *698 - ref: *699 + enterprise: *688 + installation: *689 + organization: *690 + pusher_type: *697 + ref: *698 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *692 + repository: *691 sender: *4 required: - ref @@ -117031,11 +116735,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *456 - installation: *690 - organization: *691 - enterprise: *689 - repository: *692 + alert: *454 + installation: *689 + organization: *690 + enterprise: *688 + repository: *691 sender: *4 required: - action @@ -117119,11 +116823,11 @@ webhooks: type: string enum: - auto_reopened - alert: *456 - installation: *690 - organization: *691 - enterprise: *689 - repository: *692 + alert: *454 + installation: *689 + organization: *690 + enterprise: *688 + repository: *691 sender: *4 required: - action @@ -117207,11 +116911,11 @@ webhooks: type: string enum: - created - alert: *456 - installation: *690 - organization: *691 - enterprise: *689 - repository: *692 + alert: *454 + installation: *689 + organization: *690 + enterprise: *688 + repository: *691 sender: *4 required: - action @@ -117293,11 +116997,11 @@ webhooks: type: string enum: - dismissed - alert: *456 - installation: *690 - organization: *691 - enterprise: *689 - repository: *692 + alert: *454 + installation: *689 + organization: *690 + enterprise: *688 + repository: *691 sender: *4 required: - action @@ -117379,11 +117083,11 @@ webhooks: type: string enum: - fixed - alert: *456 - installation: *690 - organization: *691 - enterprise: *689 - repository: *692 + alert: *454 + installation: *689 + organization: *690 + enterprise: *688 + repository: *691 sender: *4 required: - action @@ -117466,11 +117170,11 @@ webhooks: type: string enum: - reintroduced - alert: *456 - installation: *690 - organization: *691 - enterprise: *689 - repository: *692 + alert: *454 + installation: *689 + organization: *690 + enterprise: *688 + repository: *691 sender: *4 required: - action @@ -117552,11 +117256,11 @@ webhooks: type: string enum: - reopened - alert: *456 - installation: *690 - organization: *691 - enterprise: *689 - repository: *692 + alert: *454 + installation: *689 + organization: *690 + enterprise: *688 + repository: *691 sender: *4 required: - action @@ -117633,9 +117337,9 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - key: &700 + enterprise: *688 + installation: *689 + key: &699 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -117673,8 +117377,8 @@ webhooks: - verified - created_at - read_only - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -117751,11 +117455,11 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - key: *700 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + key: *699 + organization: *690 + repository: *691 sender: *4 required: - action @@ -118327,12 +118031,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - workflow: &704 + workflow: &703 title: Workflow type: - object @@ -119070,13 +118774,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *462 + deployment: *460 pull_requests: type: array - items: *545 - repository: *692 - organization: *691 - installation: *690 + items: *544 + repository: *691 + organization: *690 + installation: *689 sender: *4 responses: '200': @@ -119147,7 +118851,7 @@ webhooks: type: string enum: - approved - approver: &701 + approver: &700 type: object properties: avatar_url: @@ -119190,11 +118894,11 @@ webhooks: type: string comment: type: string - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 - reviewers: &702 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 + reviewers: &701 type: array items: type: object @@ -119275,7 +118979,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &703 + workflow_job_run: &702 type: object properties: conclusion: @@ -120021,18 +119725,18 @@ webhooks: type: string enum: - rejected - approver: *701 + approver: *700 comment: type: string - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 - reviewers: *702 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 + reviewers: *701 sender: *4 since: type: string - workflow_job_run: *703 + workflow_job_run: *702 workflow_job_runs: type: array items: @@ -120749,13 +120453,13 @@ webhooks: type: string enum: - requested - enterprise: *689 + enterprise: *688 environment: type: string - installation: *690 - organization: *691 - repository: *692 - requestor: &709 + installation: *689 + organization: *690 + repository: *691 + requestor: &708 title: User type: - object @@ -122698,12 +122402,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - workflow: *704 + workflow: *703 workflow_run: title: Deployment Workflow Run type: @@ -123394,7 +123098,7 @@ webhooks: type: string enum: - answered - answer: &707 + answer: &706 type: object properties: author_association: @@ -123554,7 +123258,7 @@ webhooks: - created_at - updated_at - body - discussion: &705 + discussion: &704 title: Discussion description: A Discussion in a repository. type: object @@ -123850,7 +123554,7 @@ webhooks: - id labels: type: array - items: *508 + items: *507 required: - repository_url - category @@ -123872,10 +123576,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -124002,11 +123706,11 @@ webhooks: - from required: - category - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -124089,11 +123793,11 @@ webhooks: type: string enum: - closed - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -124175,7 +123879,7 @@ webhooks: type: string enum: - created - comment: &706 + comment: &705 type: object properties: author_association: @@ -124335,11 +124039,11 @@ webhooks: - updated_at - body - reactions - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -124422,12 +124126,12 @@ webhooks: type: string enum: - deleted - comment: *706 - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + comment: *705 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -124522,12 +124226,12 @@ webhooks: - from required: - body - comment: *706 - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + comment: *705 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -124611,11 +124315,11 @@ webhooks: type: string enum: - created - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -124697,11 +124401,11 @@ webhooks: type: string enum: - deleted - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -124801,11 +124505,11 @@ webhooks: type: string required: - from - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -124887,10 +124591,10 @@ webhooks: type: string enum: - labeled - discussion: *705 - enterprise: *689 - installation: *690 - label: &708 + discussion: *704 + enterprise: *688 + installation: *689 + label: &707 title: Label type: object properties: @@ -124923,8 +124627,8 @@ webhooks: - color - default - description - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -125007,11 +124711,11 @@ webhooks: type: string enum: - locked - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -125093,11 +124797,11 @@ webhooks: type: string enum: - pinned - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -125179,11 +124883,11 @@ webhooks: type: string enum: - reopened - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -125268,16 +124972,16 @@ webhooks: changes: type: object properties: - new_discussion: *705 - new_repository: *692 + new_discussion: *704 + new_repository: *691 required: - new_discussion - new_repository - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -125360,10 +125064,10 @@ webhooks: type: string enum: - unanswered - discussion: *705 - old_answer: *707 - organization: *691 - repository: *692 + discussion: *704 + old_answer: *706 + organization: *690 + repository: *691 sender: *4 required: - action @@ -125445,12 +125149,12 @@ webhooks: type: string enum: - unlabeled - discussion: *705 - enterprise: *689 - installation: *690 - label: *708 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + label: *707 + organization: *690 + repository: *691 sender: *4 required: - action @@ -125533,11 +125237,11 @@ webhooks: type: string enum: - unlocked - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -125619,11 +125323,11 @@ webhooks: type: string enum: - unpinned - discussion: *705 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + discussion: *704 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -125696,7 +125400,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *689 + enterprise: *688 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -126374,9 +126078,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - forkee @@ -126522,9 +126226,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 pages: description: The pages that were updated. type: array @@ -126562,7 +126266,7 @@ webhooks: - action - sha - html_url - repository: *692 + repository: *691 sender: *4 required: - pages @@ -126638,10 +126342,10 @@ webhooks: type: string enum: - created - enterprise: *689 + enterprise: *688 installation: *20 - organization: *691 - repositories: &710 + organization: *690 + repositories: &709 description: An array of repository objects that the installation can access. type: array @@ -126667,8 +126371,8 @@ webhooks: - name - full_name - private - repository: *692 - requester: *709 + repository: *691 + requester: *708 sender: *4 required: - action @@ -126743,11 +126447,11 @@ webhooks: type: string enum: - deleted - enterprise: *689 + enterprise: *688 installation: *20 - organization: *691 - repositories: *710 - repository: *692 + organization: *690 + repositories: *709 + repository: *691 requester: type: - 'null' @@ -126824,11 +126528,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *689 + enterprise: *688 installation: *20 - organization: *691 - repositories: *710 - repository: *692 + organization: *690 + repositories: *709 + repository: *691 requester: type: - 'null' @@ -126905,10 +126609,10 @@ webhooks: type: string enum: - added - enterprise: *689 + enterprise: *688 installation: *20 - organization: *691 - repositories_added: &711 + organization: *690 + repositories_added: &710 description: An array of repository objects, which were added to the installation. type: array @@ -126954,15 +126658,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *692 - repository_selection: &712 + repository: *691 + repository_selection: &711 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *709 + requester: *708 sender: *4 required: - action @@ -127041,10 +126745,10 @@ webhooks: type: string enum: - removed - enterprise: *689 + enterprise: *688 installation: *20 - organization: *691 - repositories_added: *711 + organization: *690 + repositories_added: *710 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -127071,9 +126775,9 @@ webhooks: - name - full_name - private - repository: *692 - repository_selection: *712 - requester: *709 + repository: *691 + repository_selection: *711 + requester: *708 sender: *4 required: - action @@ -127152,11 +126856,11 @@ webhooks: type: string enum: - suspend - enterprise: *689 + enterprise: *688 installation: *20 - organization: *691 - repositories: *710 - repository: *692 + organization: *690 + repositories: *709 + repository: *691 requester: type: - 'null' @@ -127338,10 +127042,10 @@ webhooks: type: string required: - from - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 target_type: type: string @@ -127420,11 +127124,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *689 + enterprise: *688 installation: *20 - organization: *691 - repositories: *710 - repository: *692 + organization: *690 + repositories: *709 + repository: *691 requester: type: - 'null' @@ -127672,8 +127376,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128490,8 +128194,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128508,7 +128212,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -128852,8 +128556,8 @@ webhooks: - state - locked - assignee - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -128933,7 +128637,7 @@ webhooks: type: string enum: - deleted - comment: &713 + comment: &712 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -129100,8 +128804,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -129914,8 +129618,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 state: description: State of the issue; either 'open' or 'closed' type: string @@ -129932,7 +129636,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -130278,8 +129982,8 @@ webhooks: - state - locked - assignee - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -130359,7 +130063,7 @@ webhooks: type: string enum: - edited - changes: &737 + changes: &736 description: The changes to the comment. type: object properties: @@ -130371,9 +130075,9 @@ webhooks: type: string required: - from - comment: *713 - enterprise: *689 - installation: *690 + comment: *712 + enterprise: *688 + installation: *689 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -131189,8 +130893,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131207,7 +130911,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -131551,8 +131255,8 @@ webhooks: - state - locked - assignee - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -131642,9 +131346,9 @@ webhooks: type: number blocking_issue: *78 blocking_issue_repo: *64 - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -131738,9 +131442,9 @@ webhooks: type: number blocking_issue: *78 blocking_issue_repo: *64 - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -131833,9 +131537,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *78 - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -131929,9 +131633,9 @@ webhooks: description: The ID of the blocking issue. type: number blocking_issue: *78 - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -132016,10 +131720,10 @@ webhooks: type: string enum: - assigned - assignee: *709 - enterprise: *689 - installation: *690 - issue: &716 + assignee: *708 + enterprise: *688 + installation: *689 + issue: &715 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -132831,11 +132535,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132852,7 +132556,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -132955,8 +132659,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -133036,8 +132740,8 @@ webhooks: type: string enum: - closed - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -133854,11 +133558,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133875,7 +133579,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -134121,8 +133825,8 @@ webhooks: required: - state - closed_at - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -134201,8 +133905,8 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135010,11 +134714,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135031,7 +134735,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -135133,8 +134837,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -135213,8 +134917,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136045,11 +135749,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136066,7 +135770,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -136147,7 +135851,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &714 + milestone: &713 title: Milestone description: A collection of related issues and pull requests. type: object @@ -136290,8 +135994,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -136390,8 +136094,8 @@ webhooks: type: string required: - from - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137203,11 +136907,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137221,7 +136925,7 @@ webhooks: timeline_url: type: string format: uri - type: *205 + type: *206 title: description: Title of the issue type: string @@ -137327,9 +137031,9 @@ webhooks: - active_lock_reason - body - reactions - label: *708 - organization: *691 - repository: *692 + label: *707 + organization: *690 + repository: *691 sender: *4 required: - action @@ -137409,8 +137113,8 @@ webhooks: type: string enum: - labeled - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -138221,11 +137925,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138239,7 +137943,7 @@ webhooks: timeline_url: type: string format: uri - type: *205 + type: *206 title: description: Title of the issue type: string @@ -138345,9 +138049,9 @@ webhooks: - active_lock_reason - body - reactions - label: *708 - organization: *691 - repository: *692 + label: *707 + organization: *690 + repository: *691 sender: *4 required: - action @@ -138427,8 +138131,8 @@ webhooks: type: string enum: - locked - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139264,11 +138968,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139282,7 +138986,7 @@ webhooks: timeline_url: type: string format: uri - type: *205 + type: *206 title: description: Title of the issue type: string @@ -139365,8 +139069,8 @@ webhooks: format: uri user_view_type: type: string - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -139445,8 +139149,8 @@ webhooks: type: string enum: - milestoned - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -140276,11 +139980,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140297,7 +140001,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -140377,9 +140081,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *714 - organization: *691 - repository: *692 + milestone: *713 + organization: *690 + repository: *691 sender: *4 required: - action @@ -141271,11 +140975,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141371,7 +141075,7 @@ webhooks: required: - login - id - type: *205 + type: *206 required: - id - number @@ -141852,8 +141556,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142665,11 +142369,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142686,7 +142390,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -142788,8 +142492,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -142869,9 +142573,9 @@ webhooks: type: string enum: - pinned - enterprise: *689 - installation: *690 - issue: &715 + enterprise: *688 + installation: *689 + issue: &714 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -143677,11 +143381,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143698,7 +143402,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -143800,8 +143504,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -143880,8 +143584,8 @@ webhooks: type: string enum: - reopened - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144715,11 +144419,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144816,9 +144520,9 @@ webhooks: format: uri user_view_type: type: string - type: *205 - organization: *691 - repository: *692 + type: *206 + organization: *690 + repository: *691 sender: *4 required: - action @@ -145707,11 +145411,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145728,7 +145432,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -146310,11 +146014,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *689 - installation: *690 - issue: *715 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + issue: *714 + organization: *690 + repository: *691 sender: *4 required: - action @@ -146394,12 +146098,12 @@ webhooks: type: string enum: - typed - enterprise: *689 - installation: *690 - issue: *716 - type: *205 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + issue: *715 + type: *206 + organization: *690 + repository: *691 sender: *4 required: - action @@ -146480,7 +146184,7 @@ webhooks: type: string enum: - unassigned - assignee: &740 + assignee: &739 title: User type: - object @@ -146552,11 +146256,11 @@ webhooks: required: - login - id - enterprise: *689 - installation: *690 - issue: *716 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + issue: *715 + organization: *690 + repository: *691 sender: *4 required: - action @@ -146635,12 +146339,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *689 - installation: *690 - issue: *716 - label: *708 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + issue: *715 + label: *707 + organization: *690 + repository: *691 sender: *4 required: - action @@ -146720,8 +146424,8 @@ webhooks: type: string enum: - unlocked - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147555,11 +147259,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *623 - issue_dependencies_summary: *624 + sub_issues_summary: *622 + issue_dependencies_summary: *623 issue_field_values: type: array - items: *625 + items: *624 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147576,7 +147280,7 @@ webhooks: title: description: Title of the issue type: string - type: *205 + type: *206 updated_at: type: string format: date-time @@ -147656,8 +147360,8 @@ webhooks: format: uri user_view_type: type: string - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -147737,11 +147441,11 @@ webhooks: type: string enum: - unpinned - enterprise: *689 - installation: *690 - issue: *715 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + issue: *714 + organization: *690 + repository: *691 sender: *4 required: - action @@ -147820,12 +147524,12 @@ webhooks: type: string enum: - untyped - enterprise: *689 - installation: *690 - issue: *716 - type: *205 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + issue: *715 + type: *206 + organization: *690 + repository: *691 sender: *4 required: - action @@ -147905,11 +147609,11 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - label: *708 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + label: *707 + organization: *690 + repository: *691 sender: *4 required: - action @@ -147987,11 +147691,11 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - label: *708 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + label: *707 + organization: *690 + repository: *691 sender: *4 required: - action @@ -148101,11 +147805,11 @@ webhooks: type: string required: - from - enterprise: *689 - installation: *690 - label: *708 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + label: *707 + organization: *690 + repository: *691 sender: *4 required: - action @@ -148187,9 +147891,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *689 - installation: *690 - marketplace_purchase: &717 + enterprise: *688 + installation: *689 + marketplace_purchase: &716 title: Marketplace Purchase type: object required: @@ -148277,8 +147981,8 @@ webhooks: type: integer unit_count: type: integer - organization: *691 - previous_marketplace_purchase: &718 + organization: *690 + previous_marketplace_purchase: &717 title: Marketplace Purchase type: object properties: @@ -148362,7 +148066,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *692 + repository: *691 sender: *4 required: - action @@ -148442,10 +148146,10 @@ webhooks: - changed effective_date: type: string - enterprise: *689 - installation: *690 - marketplace_purchase: *717 - organization: *691 + enterprise: *688 + installation: *689 + marketplace_purchase: *716 + organization: *690 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -148533,7 +148237,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *692 + repository: *691 sender: *4 required: - action @@ -148615,10 +148319,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *689 - installation: *690 - marketplace_purchase: *717 - organization: *691 + enterprise: *688 + installation: *689 + marketplace_purchase: *716 + organization: *690 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -148704,7 +148408,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *692 + repository: *691 sender: *4 required: - action @@ -148785,8 +148489,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 marketplace_purchase: title: Marketplace Purchase type: object @@ -148872,9 +148576,9 @@ webhooks: type: integer unit_count: type: integer - organization: *691 - previous_marketplace_purchase: *718 - repository: *692 + organization: *690 + previous_marketplace_purchase: *717 + repository: *691 sender: *4 required: - action @@ -148954,12 +148658,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *689 - installation: *690 - marketplace_purchase: *717 - organization: *691 - previous_marketplace_purchase: *718 - repository: *692 + enterprise: *688 + installation: *689 + marketplace_purchase: *716 + organization: *690 + previous_marketplace_purchase: *717 + repository: *691 sender: *4 required: - action @@ -149061,11 +148765,11 @@ webhooks: type: string required: - to - enterprise: *689 - installation: *690 - member: *709 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + member: *708 + organization: *690 + repository: *691 sender: *4 required: - action @@ -149167,11 +148871,11 @@ webhooks: type: - string - 'null' - enterprise: *689 - installation: *690 - member: *709 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + member: *708 + organization: *690 + repository: *691 sender: *4 required: - action @@ -149250,11 +148954,11 @@ webhooks: type: string enum: - removed - enterprise: *689 - installation: *690 - member: *709 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + member: *708 + organization: *690 + repository: *691 sender: *4 required: - action @@ -149332,11 +149036,11 @@ webhooks: type: string enum: - added - enterprise: *689 - installation: *690 - member: *709 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + member: *708 + organization: *690 + repository: *691 scope: description: The scope of the membership. Currently, can only be `team`. @@ -149414,7 +149118,7 @@ webhooks: required: - login - id - team: &719 + team: &718 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -149644,11 +149348,11 @@ webhooks: type: string enum: - removed - enterprise: *689 - installation: *690 - member: *709 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + member: *708 + organization: *690 + repository: *691 scope: description: The scope of the membership. Currently, can only be `team`. @@ -149727,7 +149431,7 @@ webhooks: required: - login - id - team: *719 + team: *718 required: - action - scope @@ -149809,8 +149513,8 @@ webhooks: type: string enum: - checks_requested - installation: *690 - merge_group: &720 + installation: *689 + merge_group: &719 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -149829,15 +149533,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *393 + head_commit: *391 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -149923,10 +149627,10 @@ webhooks: - merged - invalidated - dequeued - installation: *690 - merge_group: *720 - organization: *691 - repository: *692 + installation: *689 + merge_group: *719 + organization: *690 + repository: *691 sender: *4 required: - action @@ -149999,7 +149703,7 @@ webhooks: type: string enum: - deleted - enterprise: *689 + enterprise: *688 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -150108,12 +149812,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *690 - organization: *691 + installation: *689 + organization: *690 repository: anyOf: - type: 'null' - - *692 + - *691 sender: *4 required: - action @@ -150193,11 +149897,11 @@ webhooks: type: string enum: - closed - enterprise: *689 - installation: *690 - milestone: *714 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + milestone: *713 + organization: *690 + repository: *691 sender: *4 required: - action @@ -150276,9 +149980,9 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - milestone: &721 + enterprise: *688 + installation: *689 + milestone: &720 title: Milestone description: A collection of related issues and pull requests. type: object @@ -150420,8 +150124,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -150500,11 +150204,11 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - milestone: *714 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + milestone: *713 + organization: *690 + repository: *691 sender: *4 required: - action @@ -150614,11 +150318,11 @@ webhooks: type: string required: - from - enterprise: *689 - installation: *690 - milestone: *714 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + milestone: *713 + organization: *690 + repository: *691 sender: *4 required: - action @@ -150698,11 +150402,11 @@ webhooks: type: string enum: - opened - enterprise: *689 - installation: *690 - milestone: *721 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + milestone: *720 + organization: *690 + repository: *691 sender: *4 required: - action @@ -150781,11 +150485,11 @@ webhooks: type: string enum: - blocked - blocked_user: *709 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + blocked_user: *708 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -150864,11 +150568,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *709 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + blocked_user: *708 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -150947,9 +150651,9 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - membership: &722 + enterprise: *688 + installation: *689 + membership: &721 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -151059,8 +150763,8 @@ webhooks: - role - organization_url - user - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 required: - action @@ -151138,11 +150842,11 @@ webhooks: type: string enum: - member_added - enterprise: *689 - installation: *690 - membership: *722 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + membership: *721 + organization: *690 + repository: *691 sender: *4 required: - action @@ -151221,8 +150925,8 @@ webhooks: type: string enum: - member_invited - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -151344,10 +151048,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 - user: *709 + user: *708 required: - action - invitation @@ -151425,11 +151129,11 @@ webhooks: type: string enum: - member_removed - enterprise: *689 - installation: *690 - membership: *722 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + membership: *721 + organization: *690 + repository: *691 sender: *4 required: - action @@ -151516,11 +151220,11 @@ webhooks: properties: from: type: string - enterprise: *689 - installation: *690 - membership: *722 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + membership: *721 + organization: *690 + repository: *691 sender: *4 required: - action @@ -151596,9 +151300,9 @@ webhooks: type: string enum: - published - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 package: description: Information about the package. type: object @@ -152121,7 +151825,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &723 + items: &722 title: Ruby Gems metadata type: object properties: @@ -152218,7 +151922,7 @@ webhooks: - owner - package_version - registry - repository: *692 + repository: *691 sender: *4 required: - action @@ -152294,9 +151998,9 @@ webhooks: type: string enum: - updated - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 package: description: Information about the package. type: object @@ -152658,7 +152362,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *723 + items: *722 source_url: type: string format: uri @@ -152729,7 +152433,7 @@ webhooks: - owner - package_version - registry - repository: *692 + repository: *691 sender: *4 required: - action @@ -152910,12 +152614,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *689 + enterprise: *688 id: type: integer - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - id @@ -152992,7 +152696,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &724 + personal_access_token_request: &723 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -153142,10 +152846,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *689 - organization: *691 + enterprise: *688 + organization: *690 sender: *4 - installation: *690 + installation: *689 required: - action - personal_access_token_request @@ -153222,11 +152926,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *724 - enterprise: *689 - organization: *691 + personal_access_token_request: *723 + enterprise: *688 + organization: *690 sender: *4 - installation: *690 + installation: *689 required: - action - personal_access_token_request @@ -153302,11 +153006,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *724 - enterprise: *689 - organization: *691 + personal_access_token_request: *723 + enterprise: *688 + organization: *690 sender: *4 - installation: *690 + installation: *689 required: - action - personal_access_token_request @@ -153381,11 +153085,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *724 - organization: *691 - enterprise: *689 + personal_access_token_request: *723 + organization: *690 + enterprise: *688 sender: *4 - installation: *690 + installation: *689 required: - action - personal_access_token_request @@ -153490,7 +153194,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *725 + last_response: *724 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -153522,8 +153226,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 zen: description: Random string of GitHub zen. @@ -153768,10 +153472,10 @@ webhooks: - from required: - note - enterprise: *689 - installation: *690 - organization: *691 - project_card: &726 + enterprise: *688 + installation: *689 + organization: *690 + project_card: &725 title: Project Card type: object properties: @@ -153894,7 +153598,7 @@ webhooks: - creator - created_at - updated_at - repository: *692 + repository: *691 sender: *4 required: - action @@ -153975,11 +153679,11 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 - project_card: *726 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + project_card: *725 + repository: *691 sender: *4 required: - action @@ -154059,9 +153763,9 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 project_card: title: Project Card type: object @@ -154191,7 +153895,7 @@ webhooks: repository: anyOf: - type: 'null' - - *692 + - *691 sender: *4 required: - action @@ -154285,11 +153989,11 @@ webhooks: - from required: - note - enterprise: *689 - installation: *690 - organization: *691 - project_card: *726 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + project_card: *725 + repository: *691 sender: *4 required: - action @@ -154383,9 +154087,9 @@ webhooks: - from required: - column_id - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 project_card: allOf: - title: Project Card @@ -154582,7 +154286,7 @@ webhooks: type: string required: - after_id - repository: *692 + repository: *691 sender: *4 required: - action @@ -154662,10 +154366,10 @@ webhooks: type: string enum: - closed - enterprise: *689 - installation: *690 - organization: *691 - project: &728 + enterprise: *688 + installation: *689 + organization: *690 + project: &727 title: Project type: object properties: @@ -154792,7 +154496,7 @@ webhooks: - creator - created_at - updated_at - repository: *692 + repository: *691 sender: *4 required: - action @@ -154872,10 +154576,10 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 - project_column: &727 + enterprise: *688 + installation: *689 + organization: *690 + project_column: &726 title: Project Column type: object properties: @@ -154915,7 +154619,7 @@ webhooks: - name - created_at - updated_at - repository: *692 + repository: *691 sender: *4 required: - action @@ -154994,14 +154698,14 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - organization: *691 - project_column: *727 + enterprise: *688 + installation: *689 + organization: *690 + project_column: *726 repository: anyOf: - type: 'null' - - *692 + - *691 sender: *4 required: - action @@ -155090,11 +154794,11 @@ webhooks: type: string required: - from - enterprise: *689 - installation: *690 - organization: *691 - project_column: *727 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + project_column: *726 + repository: *691 sender: *4 required: - action @@ -155174,11 +154878,11 @@ webhooks: type: string enum: - moved - enterprise: *689 - installation: *690 - organization: *691 - project_column: *727 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + project_column: *726 + repository: *691 sender: *4 required: - action @@ -155258,11 +154962,11 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 - project: *728 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + project: *727 + repository: *691 sender: *4 required: - action @@ -155342,14 +155046,14 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - organization: *691 - project: *728 + enterprise: *688 + installation: *689 + organization: *690 + project: *727 repository: anyOf: - type: 'null' - - *692 + - *691 sender: *4 required: - action @@ -155450,11 +155154,11 @@ webhooks: type: string required: - from - enterprise: *689 - installation: *690 - organization: *691 - project: *728 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + project: *727 + repository: *691 sender: *4 required: - action @@ -155533,11 +155237,11 @@ webhooks: type: string enum: - reopened - enterprise: *689 - installation: *690 - organization: *691 - project: *728 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + project: *727 + repository: *691 sender: *4 required: - action @@ -155618,8 +155322,8 @@ webhooks: type: string enum: - closed - installation: *690 - organization: *691 + installation: *689 + organization: *690 projects_v2: *239 sender: *4 required: @@ -155701,8 +155405,8 @@ webhooks: type: string enum: - created - installation: *690 - organization: *691 + installation: *689 + organization: *690 projects_v2: *239 sender: *4 required: @@ -155784,8 +155488,8 @@ webhooks: type: string enum: - deleted - installation: *690 - organization: *691 + installation: *689 + organization: *690 projects_v2: *239 sender: *4 required: @@ -155907,8 +155611,8 @@ webhooks: type: string to: type: string - installation: *690 - organization: *691 + installation: *689 + organization: *690 projects_v2: *239 sender: *4 required: @@ -155992,7 +155696,7 @@ webhooks: type: string enum: - archived - changes: &732 + changes: &731 type: object properties: archived_at: @@ -156008,9 +155712,9 @@ webhooks: - string - 'null' format: date-time - installation: *690 - organization: *691 - projects_v2_item: &729 + installation: *689 + organization: *690 + projects_v2_item: &728 title: Projects v2 Item description: An item belonging to a project type: object @@ -156150,9 +155854,9 @@ webhooks: - 'null' to: type: string - installation: *690 - organization: *691 - projects_v2_item: *729 + installation: *689 + organization: *690 + projects_v2_item: *728 sender: *4 required: - action @@ -156234,9 +155938,9 @@ webhooks: type: string enum: - created - installation: *690 - organization: *691 - projects_v2_item: *729 + installation: *689 + organization: *690 + projects_v2_item: *728 sender: *4 required: - action @@ -156317,9 +156021,9 @@ webhooks: type: string enum: - deleted - installation: *690 - organization: *691 - projects_v2_item: *729 + installation: *689 + organization: *690 + projects_v2_item: *728 sender: *4 required: - action @@ -156424,7 +156128,7 @@ webhooks: oneOf: - type: string - type: integer - - &730 + - &729 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -156448,7 +156152,7 @@ webhooks: required: - id - name - - &731 + - &730 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -156488,8 +156192,8 @@ webhooks: oneOf: - type: string - type: integer + - *729 - *730 - - *731 type: - 'null' - string @@ -156512,9 +156216,9 @@ webhooks: - 'null' required: - body - installation: *690 - organization: *691 - projects_v2_item: *729 + installation: *689 + organization: *690 + projects_v2_item: *728 sender: *4 required: - action @@ -156611,9 +156315,9 @@ webhooks: type: - string - 'null' - installation: *690 - organization: *691 - projects_v2_item: *729 + installation: *689 + organization: *690 + projects_v2_item: *728 sender: *4 required: - action @@ -156696,10 +156400,10 @@ webhooks: type: string enum: - restored - changes: *732 - installation: *690 - organization: *691 - projects_v2_item: *729 + changes: *731 + installation: *689 + organization: *690 + projects_v2_item: *728 sender: *4 required: - action @@ -156781,8 +156485,8 @@ webhooks: type: string enum: - reopened - installation: *690 - organization: *691 + installation: *689 + organization: *690 projects_v2: *239 sender: *4 required: @@ -156864,9 +156568,9 @@ webhooks: type: string enum: - created - installation: *690 - organization: *691 - projects_v2_status_update: *733 + installation: *689 + organization: *690 + projects_v2_status_update: *732 sender: *4 required: - action @@ -156947,9 +156651,9 @@ webhooks: type: string enum: - deleted - installation: *690 - organization: *691 - projects_v2_status_update: *733 + installation: *689 + organization: *690 + projects_v2_status_update: *732 sender: *4 required: - action @@ -157095,9 +156799,9 @@ webhooks: - string - 'null' format: date - installation: *690 - organization: *691 - projects_v2_status_update: *733 + installation: *689 + organization: *690 + projects_v2_status_update: *732 sender: *4 required: - action @@ -157168,10 +156872,10 @@ webhooks: title: public event type: object properties: - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - repository @@ -157248,13 +156952,13 @@ webhooks: type: string enum: - assigned - assignee: *709 - enterprise: *689 - installation: *690 - number: &734 + assignee: *708 + enterprise: *688 + installation: *689 + number: &733 description: The pull request number. type: integer - organization: *691 + organization: *690 pull_request: title: Pull Request type: object @@ -159603,7 +159307,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 sender: *4 required: - action @@ -159685,11 +159389,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 number: type: integer - organization: *691 + organization: *690 pull_request: title: Pull Request type: object @@ -162031,7 +161735,7 @@ webhooks: - draft reason: type: string - repository: *692 + repository: *691 sender: *4 required: - action @@ -162113,11 +161817,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 number: type: integer - organization: *691 + organization: *690 pull_request: title: Pull Request type: object @@ -164459,7 +164163,7 @@ webhooks: - draft reason: type: string - repository: *692 + repository: *691 sender: *4 required: - action @@ -164541,13 +164245,13 @@ webhooks: type: string enum: - closed - enterprise: *689 - installation: *690 - number: *734 - organization: *691 - pull_request: &735 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 + pull_request: &734 allOf: - - *545 + - *544 - type: object properties: allow_auto_merge: @@ -164609,7 +164313,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *692 + repository: *691 sender: *4 required: - action @@ -164690,12 +164394,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *689 - installation: *690 - number: *734 - organization: *691 - pull_request: *735 - repository: *692 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 + pull_request: *734 + repository: *691 sender: *4 required: - action @@ -164775,11 +164479,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *689 + enterprise: *688 milestone: *243 - number: *734 - organization: *691 - pull_request: &736 + number: *733 + organization: *690 + pull_request: &735 title: Pull Request type: object properties: @@ -167106,7 +166810,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 sender: *4 required: - action @@ -167185,11 +166889,11 @@ webhooks: type: string enum: - dequeued - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 number: type: integer - organization: *691 + organization: *690 pull_request: title: Pull Request type: object @@ -169535,7 +169239,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *692 + repository: *691 sender: *4 required: - action @@ -169659,12 +169363,12 @@ webhooks: type: string required: - from - enterprise: *689 - installation: *690 - number: *734 - organization: *691 - pull_request: *735 - repository: *692 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 + pull_request: *734 + repository: *691 sender: *4 required: - action @@ -169744,11 +169448,11 @@ webhooks: type: string enum: - enqueued - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 number: type: integer - organization: *691 + organization: *690 pull_request: title: Pull Request type: object @@ -172079,7 +171783,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 sender: *4 required: - action @@ -172159,11 +171863,11 @@ webhooks: type: string enum: - labeled - enterprise: *689 - installation: *690 - label: *708 - number: *734 - organization: *691 + enterprise: *688 + installation: *689 + label: *707 + number: *733 + organization: *690 pull_request: title: Pull Request type: object @@ -174511,7 +174215,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 sender: *4 required: - action @@ -174592,10 +174296,10 @@ webhooks: type: string enum: - locked - enterprise: *689 - installation: *690 - number: *734 - organization: *691 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 pull_request: title: Pull Request type: object @@ -176941,7 +176645,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 sender: *4 required: - action @@ -177021,12 +176725,12 @@ webhooks: type: string enum: - milestoned - enterprise: *689 + enterprise: *688 milestone: *243 - number: *734 - organization: *691 - pull_request: *736 - repository: *692 + number: *733 + organization: *690 + pull_request: *735 + repository: *691 sender: *4 required: - action @@ -177105,12 +176809,12 @@ webhooks: type: string enum: - opened - enterprise: *689 - installation: *690 - number: *734 - organization: *691 - pull_request: *735 - repository: *692 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 + pull_request: *734 + repository: *691 sender: *4 required: - action @@ -177191,12 +176895,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *689 - installation: *690 - number: *734 - organization: *691 - pull_request: *735 - repository: *692 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 + pull_request: *734 + repository: *691 sender: *4 required: - action @@ -177276,12 +176980,12 @@ webhooks: type: string enum: - reopened - enterprise: *689 - installation: *690 - number: *734 - organization: *691 - pull_request: *735 - repository: *692 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 + pull_request: *734 + repository: *691 sender: *4 required: - action @@ -177656,9 +177360,9 @@ webhooks: - start_side - side - reactions - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 pull_request: type: object properties: @@ -179888,7 +179592,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *692 + repository: *691 sender: *4 required: - action @@ -179968,7 +179672,7 @@ webhooks: type: string enum: - deleted - comment: &738 + comment: &737 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -180261,9 +179965,9 @@ webhooks: - start_side - side - reactions - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 pull_request: type: object properties: @@ -182481,7 +182185,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *692 + repository: *691 sender: *4 required: - action @@ -182561,11 +182265,11 @@ webhooks: type: string enum: - edited - changes: *737 - comment: *738 - enterprise: *689 - installation: *690 - organization: *691 + changes: *736 + comment: *737 + enterprise: *688 + installation: *689 + organization: *690 pull_request: type: object properties: @@ -184786,7 +184490,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *692 + repository: *691 sender: *4 required: - action @@ -184867,9 +184571,9 @@ webhooks: type: string enum: - dismissed - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 pull_request: title: Simple Pull Request type: object @@ -187102,7 +186806,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *692 + repository: *691 review: description: The review that was affected. type: object @@ -187353,9 +187057,9 @@ webhooks: type: string required: - from - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 pull_request: title: Simple Pull Request type: object @@ -189469,8 +189173,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *692 - review: &739 + repository: *691 + review: &738 description: The review that was affected. type: object properties: @@ -189708,12 +189412,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 number: description: The pull request number. type: integer - organization: *691 + organization: *690 pull_request: title: Pull Request type: object @@ -192060,7 +191764,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 requested_reviewer: title: User type: @@ -192146,12 +191850,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 number: description: The pull request number. type: integer - organization: *691 + organization: *690 pull_request: title: Pull Request type: object @@ -194505,7 +194209,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 requested_team: title: Team description: Groups of organization members that gives permissions @@ -194700,12 +194404,12 @@ webhooks: type: string enum: - review_requested - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 number: description: The pull request number. type: integer - organization: *691 + organization: *690 pull_request: title: Pull Request type: object @@ -197054,7 +196758,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 requested_reviewer: title: User type: @@ -197141,12 +196845,12 @@ webhooks: type: string enum: - review_requested - enterprise: *689 - installation: *690 + enterprise: *688 + installation: *689 number: description: The pull request number. type: integer - organization: *691 + organization: *690 pull_request: title: Pull Request type: object @@ -199486,7 +199190,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 requested_team: title: Team description: Groups of organization members that gives permissions @@ -199670,9 +199374,9 @@ webhooks: type: string enum: - submitted - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 pull_request: title: Simple Pull Request type: object @@ -201908,8 +201612,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *692 - review: *739 + repository: *691 + review: *738 sender: *4 required: - action @@ -201989,9 +201693,9 @@ webhooks: type: string enum: - resolved - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 pull_request: title: Simple Pull Request type: object @@ -204122,7 +203826,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *692 + repository: *691 sender: *4 thread: type: object @@ -204519,9 +204223,9 @@ webhooks: type: string enum: - unresolved - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 pull_request: title: Simple Pull Request type: object @@ -206635,7 +206339,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *692 + repository: *691 sender: *4 thread: type: object @@ -207034,10 +206738,10 @@ webhooks: type: string before: type: string - enterprise: *689 - installation: *690 - number: *734 - organization: *691 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 pull_request: title: Pull Request type: object @@ -209372,7 +209076,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 sender: *4 required: - action @@ -209454,11 +209158,11 @@ webhooks: type: string enum: - unassigned - assignee: *740 - enterprise: *689 - installation: *690 - number: *734 - organization: *691 + assignee: *739 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 pull_request: title: Pull Request type: object @@ -211808,7 +211512,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 sender: *4 required: - action @@ -211887,11 +211591,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *689 - installation: *690 - label: *708 - number: *734 - organization: *691 + enterprise: *688 + installation: *689 + label: *707 + number: *733 + organization: *690 pull_request: title: Pull Request type: object @@ -214230,7 +213934,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 sender: *4 required: - action @@ -214311,10 +214015,10 @@ webhooks: type: string enum: - unlocked - enterprise: *689 - installation: *690 - number: *734 - organization: *691 + enterprise: *688 + installation: *689 + number: *733 + organization: *690 pull_request: title: Pull Request type: object @@ -216643,7 +216347,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *692 + repository: *691 sender: *4 required: - action @@ -216846,7 +216550,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *689 + enterprise: *688 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -216941,8 +216645,8 @@ webhooks: - url - author - committer - installation: *690 - organization: *691 + installation: *689 + organization: *690 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -217530,9 +217234,9 @@ webhooks: type: string enum: - published - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 registry_package: type: object properties: @@ -218009,7 +217713,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *723 + items: *722 summary: type: string tag_name: @@ -218065,7 +217769,7 @@ webhooks: - owner - package_version - registry - repository: *692 + repository: *691 sender: *4 required: - action @@ -218143,9 +217847,9 @@ webhooks: type: string enum: - updated - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 registry_package: type: object properties: @@ -218457,7 +218161,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *723 + items: *722 summary: type: string tag_name: @@ -218507,7 +218211,7 @@ webhooks: - owner - package_version - registry - repository: *692 + repository: *691 sender: *4 required: - action @@ -218584,10 +218288,10 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 - release: &741 + enterprise: *688 + installation: *689 + organization: *690 + release: &740 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -218918,7 +218622,7 @@ webhooks: - updated_at - zipball_url - body - repository: *692 + repository: *691 sender: *4 required: - action @@ -218995,11 +218699,11 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - organization: *691 - release: *741 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + release: *740 + repository: *691 sender: *4 required: - action @@ -219116,11 +218820,11 @@ webhooks: type: boolean required: - to - enterprise: *689 - installation: *690 - organization: *691 - release: *741 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + release: *740 + repository: *691 sender: *4 required: - action @@ -219198,9 +218902,9 @@ webhooks: type: string enum: - prereleased - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -219536,7 +219240,7 @@ webhooks: - string - 'null' format: uri - repository: *692 + repository: *691 sender: *4 required: - action @@ -219612,10 +219316,10 @@ webhooks: type: string enum: - published - enterprise: *689 - installation: *690 - organization: *691 - release: &742 + enterprise: *688 + installation: *689 + organization: *690 + release: &741 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -219948,7 +219652,7 @@ webhooks: - string - 'null' format: uri - repository: *692 + repository: *691 sender: *4 required: - action @@ -220024,11 +219728,11 @@ webhooks: type: string enum: - released - enterprise: *689 - installation: *690 - organization: *691 - release: *741 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + release: *740 + repository: *691 sender: *4 required: - action @@ -220104,11 +219808,11 @@ webhooks: type: string enum: - unpublished - enterprise: *689 - installation: *690 - organization: *691 - release: *742 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + release: *741 + repository: *691 sender: *4 required: - action @@ -220184,11 +219888,11 @@ webhooks: type: string enum: - published - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 - repository_advisory: *609 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 + repository_advisory: *608 sender: *4 required: - action @@ -220264,11 +219968,11 @@ webhooks: type: string enum: - reported - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 - repository_advisory: *609 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 + repository_advisory: *608 sender: *4 required: - action @@ -220344,10 +220048,10 @@ webhooks: type: string enum: - archived - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -220424,10 +220128,10 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -220505,10 +220209,10 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -220593,10 +220297,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -220711,10 +220415,10 @@ webhooks: - 'null' items: type: string - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -220786,10 +220490,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 status: type: string @@ -220870,10 +220574,10 @@ webhooks: type: string enum: - privatized - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -220950,10 +220654,10 @@ webhooks: type: string enum: - publicized - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -221047,10 +220751,10 @@ webhooks: - name required: - repository - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -221130,10 +220834,10 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 repository_ruleset: *280 sender: *4 required: @@ -221212,10 +220916,10 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 repository_ruleset: *280 sender: *4 required: @@ -221294,10 +220998,10 @@ webhooks: type: string enum: - edited - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 repository_ruleset: *280 changes: type: object @@ -221359,16 +221063,16 @@ webhooks: properties: added: type: array - items: *566 + items: *565 deleted: type: array - items: *566 + items: *565 updated: type: array items: type: object properties: - rule: *566 + rule: *565 changes: type: object properties: @@ -221605,10 +221309,10 @@ webhooks: - from required: - owner - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -221686,10 +221390,10 @@ webhooks: type: string enum: - unarchived - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -221767,7 +221471,7 @@ webhooks: type: string enum: - create - alert: &743 + alert: &742 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -221891,10 +221595,10 @@ webhooks: type: string enum: - open - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -222104,10 +221808,10 @@ webhooks: type: string enum: - dismissed - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -222185,11 +221889,11 @@ webhooks: type: string enum: - reopen - alert: *743 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + alert: *742 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -222391,10 +222095,10 @@ webhooks: enum: - fixed - open - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -222472,17 +222176,17 @@ webhooks: type: string enum: - created - alert: &744 + alert: &743 type: object properties: - number: *151 - created_at: *152 + number: *152 + created_at: *153 updated_at: anyOf: - type: 'null' - - *153 - url: *154 - html_url: *155 + - *154 + url: *155 + html_url: *156 locations_url: type: string format: uri @@ -222586,10 +222290,10 @@ webhooks: anyOf: - type: 'null' - *4 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -222670,11 +222374,11 @@ webhooks: type: string enum: - created - alert: *744 - installation: *690 - location: *745 - organization: *691 - repository: *692 + alert: *743 + installation: *689 + location: *744 + organization: *690 + repository: *691 sender: *4 required: - location @@ -222912,11 +222616,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *744 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + alert: *743 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -222994,11 +222698,11 @@ webhooks: type: string enum: - reopened - alert: *744 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + alert: *743 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -223076,11 +222780,11 @@ webhooks: type: string enum: - resolved - alert: *744 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + alert: *743 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -223158,11 +222862,11 @@ webhooks: type: string enum: - validated - alert: *744 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + alert: *743 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -223292,10 +222996,10 @@ webhooks: - organization - enterprise - - repository: *692 - enterprise: *689 - installation: *690 - organization: *691 + repository: *691 + enterprise: *688 + installation: *689 + organization: *690 sender: *4 required: - action @@ -223373,11 +223077,11 @@ webhooks: type: string enum: - published - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 - security_advisory: &746 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 + security_advisory: &745 description: The details of the security advisory, including summary, description, and severity. type: object @@ -223563,11 +223267,11 @@ webhooks: type: string enum: - updated - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 - security_advisory: *746 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 + security_advisory: *745 sender: *4 required: - action @@ -223640,10 +223344,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -223830,10 +223534,10 @@ webhooks: type: object properties: security_and_analysis: *254 - enterprise: *689 - installation: *690 - organization: *691 - repository: *316 + enterprise: *688 + installation: *689 + organization: *690 + repository: *314 sender: *4 required: - changes @@ -223911,12 +223615,12 @@ webhooks: type: string enum: - cancelled - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - sponsorship: &747 + sponsorship: &746 type: object properties: created_at: @@ -224221,12 +223925,12 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - sponsorship: *747 + sponsorship: *746 required: - action - sponsorship @@ -224314,12 +224018,12 @@ webhooks: type: string required: - from - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - sponsorship: *747 + sponsorship: *746 required: - action - changes @@ -224396,17 +224100,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &748 + effective_date: &747 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: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - sponsorship: *747 + sponsorship: *746 required: - action - sponsorship @@ -224480,7 +224184,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &749 + changes: &748 type: object properties: tier: @@ -224524,13 +224228,13 @@ webhooks: - from required: - tier - effective_date: *748 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + effective_date: *747 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - sponsorship: *747 + sponsorship: *746 required: - action - changes @@ -224607,13 +224311,13 @@ webhooks: type: string enum: - tier_changed - changes: *749 - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + changes: *748 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - sponsorship: *747 + sponsorship: *746 required: - action - changes @@ -224687,10 +224391,10 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -224774,10 +224478,10 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -225211,15 +224915,15 @@ webhooks: type: - string - 'null' - enterprise: *689 + enterprise: *688 id: description: The unique identifier of the status. type: integer - installation: *690 + installation: *689 name: type: string - organization: *691 - repository: *692 + organization: *690 + repository: *691 sender: *4 sha: description: The Commit SHA. @@ -225335,9 +225039,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *78 - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -225427,9 +225131,9 @@ webhooks: description: The ID of the sub-issue. type: number sub_issue: *78 - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -225519,9 +225223,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *78 - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -225611,9 +225315,9 @@ webhooks: description: The ID of the parent issue. type: number parent_issue: *78 - installation: *690 - organization: *691 - repository: *692 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -225690,12 +225394,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - team: &750 + team: &749 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -225925,9 +225629,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 repository: title: Repository description: A git repository @@ -226397,7 +226101,7 @@ webhooks: - topics - visibility sender: *4 - team: *750 + team: *749 required: - action - team @@ -226473,9 +226177,9 @@ webhooks: type: string enum: - created - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 repository: title: Repository description: A git repository @@ -226945,7 +226649,7 @@ webhooks: - topics - visibility sender: *4 - team: *750 + team: *749 required: - action - team @@ -227022,9 +226726,9 @@ webhooks: type: string enum: - deleted - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 repository: title: Repository description: A git repository @@ -227494,7 +227198,7 @@ webhooks: - topics - visibility sender: *4 - team: *750 + team: *749 required: - action - team @@ -227638,9 +227342,9 @@ webhooks: - from required: - permissions - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 repository: title: Repository description: A git repository @@ -228110,7 +227814,7 @@ webhooks: - topics - visibility sender: *4 - team: *750 + team: *749 required: - action - changes @@ -228188,9 +227892,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *689 - installation: *690 - organization: *691 + enterprise: *688 + installation: *689 + organization: *690 repository: title: Repository description: A git repository @@ -228660,7 +228364,7 @@ webhooks: - topics - visibility sender: *4 - team: *750 + team: *749 required: - action - team @@ -228736,10 +228440,10 @@ webhooks: type: string enum: - started - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 required: - action @@ -228812,17 +228516,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *689 + enterprise: *688 inputs: type: - object - 'null' additionalProperties: true - installation: *690 - organization: *691 + installation: *689 + organization: *690 ref: type: string - repository: *692 + repository: *691 sender: *4 workflow: type: string @@ -228904,10 +228608,10 @@ webhooks: type: string enum: - completed - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 workflow_job: allOf: @@ -229163,7 +228867,7 @@ webhooks: type: string required: - conclusion - deployment: *462 + deployment: *460 required: - action - repository @@ -229242,10 +228946,10 @@ webhooks: type: string enum: - in_progress - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 workflow_job: allOf: @@ -229527,7 +229231,7 @@ webhooks: required: - status - steps - deployment: *462 + deployment: *460 required: - action - repository @@ -229606,10 +229310,10 @@ webhooks: type: string enum: - queued - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 workflow_job: type: object @@ -229755,7 +229459,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *462 + deployment: *460 required: - action - repository @@ -229834,10 +229538,10 @@ webhooks: type: string enum: - waiting - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 workflow_job: type: object @@ -229984,7 +229688,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *462 + deployment: *460 required: - action - repository @@ -230064,12 +229768,12 @@ webhooks: type: string enum: - completed - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - workflow: *704 + workflow: *703 workflow_run: title: Workflow Run type: object @@ -231088,12 +230792,12 @@ webhooks: type: string enum: - in_progress - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - workflow: *704 + workflow: *703 workflow_run: title: Workflow Run type: object @@ -232097,12 +231801,12 @@ webhooks: type: string enum: - requested - enterprise: *689 - installation: *690 - organization: *691 - repository: *692 + enterprise: *688 + installation: *689 + organization: *690 + repository: *691 sender: *4 - workflow: *704 + workflow: *703 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 383c409a5..50c0b007a 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -66907,6 +66907,1849 @@ } } }, + "/enterprises/{enterprise}/settings/billing/budgets": { + "get": { + "summary": "Get all budgets", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all budgets for an enterprise. The authenticated user must be an enterprise admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-all-budgets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-all-budgets" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response when getting all budgets", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "budgets": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the budget", + "examples": [ + "2066deda-923f-43f9-88d2-62395a28c0cdd" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "SkuPricing", + "ProductPricing" + ], + "examples": [ + "SkuPricing" + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount limit in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "The type of limit enforcement for the budget", + "examples": [ + true + ] + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "examples": [ + "octocat/hello-world" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to." + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + }, + "required": [ + "will_alert", + "alert_recipients" + ] + } + }, + "required": [ + "id", + "budget_type", + "budget_product_sku", + "budget_scope", + "budget_amount", + "prevent_further_usage", + "budget_alerting" + ] + }, + "description": "Array of budget objects for the enterprise" + } + }, + "required": [ + "budgets" + ] + }, + "examples": { + "default": { + "value": { + "budgets": [ + { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "actions" + ], + "budget_scope": "enterprise", + "budget_amount": 1000.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "enterprise-admin", + "billing-manager" + ] + } + }, + { + "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", + "budget_type": "SkuPricing", + "budget_product_skus": [ + "actions_linux" + ], + "budget_scope": "organization", + "budget_amount": 500.0, + "prevent_further_usage": false, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "org-owner" + ] + } + }, + { + "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "packages" + ], + "budget_scope": "cost_center", + "budget_amount": 250.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + ] + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "post": { + "summary": "Create a budget", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "tags": [ + "billing" + ], + "operationId": "billing/create-budget", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#create-a-budget" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "budget_amount", + "prevent_further_usage", + "budget_alerting", + "budget_scope", + "budget_type" + ], + "properties": { + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "required": [ + "will_alert", + "alert_recipients" + ], + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "default": "" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + }, + "examples": { + "create-budget": { + "summary": "Create budget example", + "value": { + "budget_amount": 200, + "prevent_further_usage": true, + "budget_scope": "enterprise", + "budget_entity_name": "", + "budget_type": "ProductPricing", + "budget_product_sku": "actions", + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Budget created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the create operation" + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ], + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "examples": [ + "example-repository-name" + ] + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in dollars", + "minimum": 0.0, + "examples": [ + 100.0 + ] + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "examples": [ + true + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "examples": [ + "actions_linux" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ], + "examples": [ + "ProductPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + } + } + } + } + }, + "required": [ + "message", + "budget" + ] + }, + "examples": { + "create-budget": { + "value": { + "message": "Budget successfully created." + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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": "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": { + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#create-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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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 create budget.", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#create-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, + "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": { + "get": { + "summary": "Get a budget by ID", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a budget by ID. The authenticated user must be an enterprise admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-budget", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-a-budget-by-id" + }, + "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 updating a budget", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ], + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "examples": [ + "octocat/hello-world" + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "examples": [ + true + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "examples": [ + "actions_linux" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ], + "examples": [ + "ProductPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + } + } + }, + "required": [ + "id", + "budget_amount", + "prevent_further_usage", + "budget_product_sku", + "budget_type", + "budget_alerting", + "budget_scope", + "budget_entity_name" + ] + }, + "examples": { + "default": { + "value": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "patch": { + "summary": "Update a budget", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nUpdates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "tags": [ + "billing" + ], + "operationId": "billing/update-budget", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#update-a-budget" + }, + "parameters": [ + { + "name": "enterprise", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The slug version of the enterprise name" + }, + { + "name": "budget_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the budget" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + }, + "examples": { + "update-budget": { + "summary": "Update budget example", + "value": { + "prevent_further_usage": false, + "budget_amount": 10, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Budget updated successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the update operation" + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ], + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "examples": [ + "example-repository-name" + ] + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in dollars", + "minimum": 0.0, + "examples": [ + 100.0 + ] + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "examples": [ + true + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "examples": [ + "actions_linux" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ], + "examples": [ + "ProductPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + } + } + } + } + }, + "required": [ + "budget", + "message" + ] + }, + "examples": { + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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/enhanced-billing#update-a-budget" + } + }, + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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/enterprise-admin/billing#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/enhanced-billing#update-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "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/enhanced-billing#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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, "/enterprises/{enterprise}/settings/billing/cost-centers": { "get": { "summary": "Get all cost centers for an enterprise", @@ -69672,7 +71515,7 @@ }, "/enterprises/{enterprise}/settings/billing/usage/summary": { "get": { - "summary": "Get billing usage summary report for an enterprise", + "summary": "Get billing usage summary for an enterprise", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default, this endpoint will return usage across all cost centers in the enterprise.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" @@ -69680,7 +71523,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-ghe", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-summary-report-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-summary-for-an-enterprise" }, "parameters": [ { @@ -69767,7 +71610,7 @@ ], "responses": { "200": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { @@ -108196,6 +110039,1320 @@ } } }, + "/organizations/{org}/settings/billing/budgets": { + "get": { + "summary": "Get all budgets for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all budgets for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-all-budgets-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-all-budgets-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 when getting all budgets", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "budgets": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the budget", + "examples": [ + "2066deda-923f-43f9-88d2-62395a28c0cdd" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "SkuPricing", + "ProductPricing" + ], + "examples": [ + "SkuPricing" + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount limit in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "The type of limit enforcement for the budget", + "examples": [ + true + ] + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "examples": [ + "octocat/hello-world" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to." + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + }, + "required": [ + "will_alert", + "alert_recipients" + ] + } + }, + "required": [ + "id", + "budget_type", + "budget_product_sku", + "budget_scope", + "budget_amount", + "prevent_further_usage", + "budget_alerting" + ] + }, + "description": "Array of budget objects for the enterprise" + } + }, + "required": [ + "budgets" + ] + }, + "examples": { + "default": { + "value": { + "budgets": [ + { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "actions" + ], + "budget_scope": "enterprise", + "budget_amount": 1000.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "enterprise-admin", + "billing-manager" + ] + } + }, + { + "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", + "budget_type": "SkuPricing", + "budget_product_skus": [ + "actions_linux" + ], + "budget_scope": "organization", + "budget_amount": 500.0, + "prevent_further_usage": false, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "org-owner" + ] + } + }, + { + "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "packages" + ], + "budget_scope": "cost_center", + "budget_amount": 250.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + ] + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, + "/organizations/{org}/settings/billing/budgets/{budget_id}": { + "get": { + "summary": "Get a budget by ID for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a budget by ID. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-a-budget-by-id-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "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 updating a budget", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ], + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "examples": [ + "octocat/hello-world" + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "examples": [ + true + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "examples": [ + "actions_linux" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ], + "examples": [ + "ProductPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + } + } + }, + "required": [ + "id", + "budget_amount", + "prevent_further_usage", + "budget_product_sku", + "budget_type", + "budget_alerting", + "budget_scope", + "budget_entity_name" + ] + }, + "examples": { + "default": { + "value": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "patch": { + "summary": "Update a budget for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nUpdates an existing budget for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/update-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#update-a-budget-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "budget_id", + "description": "The ID corresponding to the budget.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + }, + "examples": { + "update-budget": { + "summary": "Update budget example", + "value": { + "prevent_further_usage": false, + "budget_amount": 10, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Budget updated successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": [ + "Budget successfully updated." + ] + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "required": [ + "will_alert", + "alert_recipients" + ], + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "default": "" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + } + } + }, + "examples": { + "update-budget": { + "value": { + "message": "Budget successfully updated.", + "id": "550e8400-e29b-41d4-a716-446655440000" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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/enhanced-billing#update-a-budget" + } + }, + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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 update budget.", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "delete": { + "summary": "Delete a budget for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/delete-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#delete-a-budget-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", @@ -108893,7 +112050,7 @@ }, "/organizations/{org}/settings/billing/usage/summary": { "get": { - "summary": "Get billing usage summary report for an organization", + "summary": "Get billing usage summary for an organization", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" @@ -108901,7 +112058,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-report-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-for-an-organization" }, "parameters": [ { @@ -108970,7 +112127,7 @@ ], "responses": { "200": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { @@ -201680,999 +204837,6 @@ } } }, - "/orgs/{org}/projects": { - "get": { - "summary": "List organization 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-organization-projects" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - } - }, - "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": true - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create an organization 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-an-organization-project" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the project." - }, - "body": { - "type": "string", - "description": "The description of the project." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "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" - } - } - } - } - } - }, - "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": "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/orgs/{org}/projectsV2": { "get": { "summary": "List projects for organization", @@ -265042,1125 +267206,6 @@ "deprecated": true } }, - "/projects/{project_id}": { - "get": { - "summary": "Get 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": [ - "projects-classic" - ], - "operationId": "projects-classic/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#get-a-project" - }, - "parameters": [ - { - "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": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "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": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update 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.", - "operationId": "projects-classic/update", - "tags": [ - "projects-classic" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#update-a-project" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone.", - "type": "boolean" - } - }, - "type": "object" - }, - "examples": { - "default": { - "summary": "Change the name, state, and permissions for a project", - "value": { - "name": "Week One Sprint", - "state": "open", - "organization_permission": "write" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "404": { - "description": "Not Found if the authenticated user does not have access to the project" - }, - "304": { - "description": "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": { - "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete 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.", - "operationId": "projects-classic/delete", - "tags": [ - "projects-classic" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#delete-a-project" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Delete Success" - }, - "304": { - "description": "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": { - "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/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": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/projects/{project_id}/collaborators": { "get": { "summary": "List project collaborators", @@ -541091,1421 +542136,77 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pages", - "subcategory": "pages" - } - } - }, - "/repos/{owner}/{repo}/private-vulnerability-reporting": { - "get": { - "summary": "Check if private vulnerability reporting is enabled for a repository", - "description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".", - "tags": [ - "repos" - ], - "operationId": "repos/check-private-vulnerability-reporting", - "externalDocs": { - "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": [ - { - "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": "Private vulnerability reporting status", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Whether or not private vulnerability reporting is enabled for the repository." - } - }, - "required": [ - "enabled" - ] - }, - "examples": { - "default": { - "value": { - "enabled": true - } - } - } - } - } - }, - "422": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" - } - }, - "put": { - "summary": "Enable private vulnerability reporting for a repository", - "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"", - "tags": [ - "repos" - ], - "operationId": "repos/enable-private-vulnerability-reporting", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-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": { - "204": { - "description": "A header with no content is returned." - }, - "422": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" - } - }, - "delete": { - "summary": "Disable private vulnerability reporting for a repository", - "description": "Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".", - "tags": [ - "repos" - ], - "operationId": "repos/disable-private-vulnerability-reporting", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-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": { - "204": { - "description": "A header with no content is returned." - }, - "422": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" - } - } - }, - "/repos/{owner}/{repo}/projects": { - "get": { - "summary": "List repository 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-repository-projects" - }, - "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" - } - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "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": "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create a repository 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-a-repository-project" - }, - "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": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the project." - }, - "body": { - "type": "string", - "description": "The description of the project." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "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": "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": "pages", + "subcategory": "pages" + } + } + }, + "/repos/{owner}/{repo}/private-vulnerability-reporting": { + "get": { + "summary": "Check if private vulnerability reporting is enabled for a repository", + "description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".", + "tags": [ + "repos" + ], + "operationId": "repos/check-private-vulnerability-reporting", + "externalDocs": { + "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": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "410": { - "description": "Gone", + { + "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": "Private vulnerability reporting status", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether or not private vulnerability reporting is enabled for the repository." + } + }, + "required": [ + "enabled" + ] + }, + "examples": { + "default": { + "value": { + "enabled": true + } + } + } + } + } + }, + "422": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -542527,21 +542228,102 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + }, + "put": { + "summary": "Enable private vulnerability reporting for a repository", + "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"", + "tags": [ + "repos" + ], + "operationId": "repos/enable-private-vulnerability-reporting", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-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": { + "204": { + "description": "A header with no content is returned." }, "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "description": "Bad Request", "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -542549,7 +542331,49 @@ "documentation_url": { "type": "string" }, - "errors": { + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { "type": "array", "items": { "type": "string" @@ -542564,12 +542388,120 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" + "category": "repos", + "subcategory": "repos" + } + }, + "delete": { + "summary": "Disable private vulnerability reporting for a repository", + "description": "Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".", + "tags": [ + "repos" + ], + "operationId": "repos/disable-private-vulnerability-reporting", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository" }, - "deprecated": true + "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": { + "204": { + "description": "A header with no content is returned." + }, + "422": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } } }, "/repos/{owner}/{repo}/properties/values": { @@ -609901,8 +609833,12 @@ ] } }, - "required": [ - "state" + "anyOf": [ + { + "required": [ + "state" + ] + } ] }, "examples": { @@ -724159,498 +724095,6 @@ } } }, - "/user/projects": { - "post": { - "summary": "Create a user 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-a-user-project" - }, - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Create a new project", - "value": { - "name": "My Projects", - "body": "A board to manage my personal projects." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "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 Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/user/public_emails": { "get": { "summary": "List public email addresses for the authenticated user", @@ -761792,503 +761236,6 @@ } } }, - "/users/{username}/projects": { - "get": { - "summary": "List user 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-user-projects" - }, - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/users/{username}/projectsV2": { "get": { "summary": "List projects for user", @@ -789752,7 +788699,7 @@ }, "/users/{username}/settings/billing/usage/summary": { "get": { - "summary": "Get billing usage summary report for a user", + "summary": "Get billing usage summary for a user", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" @@ -789760,7 +788707,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-report-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-for-a-user" }, "parameters": [ { @@ -789829,7 +788776,7 @@ ], "responses": { "200": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 6af65f838..8464d7796 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -915,7 +915,7 @@ paths: - subscriptions_url - type - url - type: &415 + type: &418 type: string description: The type of credit the user is receiving. enum: @@ -1048,7 +1048,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &245 + schema: &249 title: Validation Error Simple description: Validation Error Simple type: object @@ -1081,7 +1081,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &735 + - &737 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1666,7 +1666,7 @@ paths: schema: type: integer default: 30 - - &329 + - &333 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 @@ -1682,7 +1682,7 @@ paths: application/json: schema: type: array - items: &330 + items: &334 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1778,7 +1778,7 @@ paths: - installation_id - repository_id examples: - default: &331 + default: &335 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1810,7 +1810,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &745 + schema: &747 title: Scim Error description: Scim Error type: object @@ -1841,7 +1841,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &244 + schema: &248 title: Validation Error description: Validation Error type: object @@ -1913,7 +1913,7 @@ paths: description: Response content: application/json: - schema: &332 + schema: &336 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -2048,7 +2048,7 @@ paths: - request - response examples: - default: &333 + default: &337 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2252,7 +2252,7 @@ paths: parameters: - *17 - *19 - - &208 + - &209 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) @@ -3055,7 +3055,7 @@ paths: license: anyOf: - type: 'null' - - &219 + - &220 title: License Simple description: License Simple type: object @@ -7804,7 +7804,7 @@ paths: description: Response content: application/json: - schema: &246 + schema: &250 type: object properties: total_active_caches_count: @@ -7819,7 +7819,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &247 + default: &251 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -8034,7 +8034,7 @@ paths: - public_ip_enabled - platform examples: - default: &248 + default: &252 value: total_count: 2 runners: @@ -8338,7 +8338,7 @@ paths: application/json: schema: *43 examples: - default: &249 + default: &253 value: id: 1 platform: linux-x64 @@ -8483,7 +8483,7 @@ paths: application/json: schema: *46 examples: - default: &250 + default: &254 value: version: 1.0.0 size_gb: 75 @@ -8651,7 +8651,7 @@ paths: description: Response content: application/json: - schema: &251 + schema: &255 type: object properties: public_ips: @@ -8678,7 +8678,7 @@ paths: required: - public_ips examples: - default: &252 + default: &256 value: public_ips: current_usage: 17 @@ -8718,7 +8718,7 @@ paths: type: array items: *50 examples: - default: &253 + default: &257 value: id: 4-core cpu_cores: 4 @@ -8982,7 +8982,7 @@ paths: - all - local_only - selected - selected_actions_url: &256 + selected_actions_url: &260 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` @@ -9062,7 +9062,7 @@ paths: description: Successfully retrieved the artifact and log retention settings content: application/json: - schema: &258 + schema: &262 type: object properties: days: @@ -9080,7 +9080,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &746 + '401': &748 description: Authorization failure '404': *6 x-github: @@ -9108,7 +9108,7 @@ paths: required: true content: application/json: - schema: &259 + schema: &263 type: object properties: days: @@ -9157,7 +9157,7 @@ paths: required: - approval_policy examples: - default: &260 + default: &264 value: approval_policy: first_time_contributors '404': *6 @@ -9215,7 +9215,7 @@ paths: description: Response content: application/json: - schema: &261 + schema: &265 type: object required: - run_workflows_from_fork_pull_requests @@ -9269,7 +9269,7 @@ paths: required: true content: application/json: - schema: &262 + schema: &266 type: object required: - run_workflows_from_fork_pull_requests @@ -9705,7 +9705,7 @@ paths: description: Success response content: application/json: - schema: &265 + schema: &269 type: object properties: default_workflow_permissions: &61 @@ -9753,7 +9753,7 @@ paths: required: true content: application/json: - schema: &266 + schema: &270 type: object properties: default_workflow_permissions: *61 @@ -10598,7 +10598,7 @@ paths: application/json: schema: type: array - items: &270 + items: &274 title: Runner Application description: Runner Application type: object @@ -10623,7 +10623,7 @@ paths: - download_url - filename examples: - default: &271 + default: &275 value: - os: osx architecture: x64 @@ -10707,7 +10707,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &272 + '201': &276 description: Response content: application/json: @@ -10826,7 +10826,7 @@ paths: - token - expires_at examples: - default: &273 + default: &277 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -10866,7 +10866,7 @@ paths: application/json: schema: *73 examples: - default: &274 + default: &278 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -10898,7 +10898,7 @@ paths: application/json: schema: *70 examples: - default: &275 + default: &279 value: id: 23 name: MBP @@ -11114,7 +11114,7 @@ paths: - *39 - *69 responses: - '200': &276 + '200': &280 description: Response content: application/json: @@ -11170,7 +11170,7 @@ paths: parameters: - *39 - *69 - - &277 + - &281 name: name description: The name of a self-hosted runner's custom label. in: path @@ -11267,7 +11267,7 @@ paths: required: true content: application/json: - schema: &284 + schema: &288 title: Enterprise Announcement description: Enterprise global announcement type: object @@ -11918,7 +11918,7 @@ paths: required: false schema: type: string - - &285 + - &289 name: include description: |- The event types to include: @@ -11936,7 +11936,7 @@ paths: - web - git - all - - &286 + - &290 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. @@ -11944,7 +11944,7 @@ paths: required: false schema: type: string - - &287 + - &291 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. @@ -11952,7 +11952,7 @@ paths: required: false schema: type: string - - &288 + - &292 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -11974,7 +11974,7 @@ paths: application/json: schema: type: array - items: &289 + items: &293 type: object properties: "@timestamp": @@ -12096,7 +12096,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &290 + default: &294 value: - "@timestamp": 1606929874512 action: team.add_member @@ -12764,7 +12764,7 @@ paths: application/json: schema: type: array - items: &291 + items: &295 title: Push rule bypass request description: A bypass request made by a user asking to be exempted from a push rule in this repository. @@ -12936,7 +12936,7 @@ paths: examples: - https://github.com/octo-org/smile/exemptions/1 examples: - default: &292 + default: &296 value: - id: 21 number: 42 @@ -13041,7 +13041,7 @@ paths: application/json: schema: type: array - items: &294 + items: &298 title: Secret scanning bypass request description: A bypass request made by a user asking to be exempted from push protection in this repository. @@ -13172,7 +13172,7 @@ paths: examples: - https://github.com/octo-org/smile/exemptions/1 examples: - default: &295 + default: &299 value: - id: 21 number: 42 @@ -13257,7 +13257,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *39 - - &300 + - &304 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`, @@ -13267,7 +13267,7 @@ paths: schema: &105 type: string description: The name of the tool used to generate the code scanning analysis. - - &301 + - &305 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 @@ -13291,7 +13291,7 @@ paths: be returned. in: query required: false - schema: &302 + schema: &306 type: string description: State of a code scanning alert. enum: @@ -13316,7 +13316,7 @@ paths: application/json: schema: type: array - items: &303 + items: &307 type: object properties: number: &119 @@ -13345,7 +13345,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &528 + instances_url: &529 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13381,7 +13381,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &529 + dismissed_reason: &530 type: - string - 'null' @@ -13392,14 +13392,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &530 + dismissed_comment: &531 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &531 + rule: &532 type: object properties: id: @@ -13460,7 +13460,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &532 + tool: &533 type: object properties: name: *105 @@ -13471,15 +13471,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *106 - most_recent_instance: &533 + most_recent_instance: &534 type: object properties: - ref: &526 + ref: &527 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &543 + analysis_key: &544 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -13490,7 +13490,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &544 + category: &545 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -13881,7 +13881,7 @@ paths: - most_recent_instance - repository examples: - default: &304 + default: &308 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -14540,7 +14540,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &305 + code_scanning_options: &309 type: - object - 'null' @@ -14738,7 +14738,7 @@ paths: description: Response content: application/json: - schema: &307 + schema: &311 type: array description: A list of default code security configurations items: @@ -14754,7 +14754,7 @@ paths: default configuration: *108 examples: - default: &308 + default: &312 value: - default_for_new_repos: public configuration: @@ -15208,7 +15208,7 @@ paths: default: value: default_for_new_repos: all - configuration: &306 + configuration: &310 value: id: 1325 target_type: organization @@ -15293,7 +15293,7 @@ paths: application/json: schema: type: array - items: &309 + items: &313 type: object description: Repositories associated with a code security configuration and attachment status @@ -15317,7 +15317,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &310 + repository: &314 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -15818,7 +15818,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &296 + - &300 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -15895,7 +15895,7 @@ paths: parent: anyOf: - type: 'null' - - &364 + - &368 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -16588,7 +16588,7 @@ paths: application/json: schema: type: array - items: &195 + items: &196 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -16903,7 +16903,7 @@ paths: - date additionalProperties: true examples: - default: &196 + default: &197 value: - date: '2024-06-24' total_active_users: 24 @@ -17005,7 +17005,7 @@ paths: '500': *38 '403': *27 '404': *6 - '422': &197 + '422': &198 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -17242,7 +17242,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *39 - - &316 + - &320 name: state in: query description: |- @@ -17251,7 +17251,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &317 + - &321 name: severity in: query description: |- @@ -17260,7 +17260,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &318 + - &322 name: ecosystem in: query description: |- @@ -17269,14 +17269,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &319 + - &323 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 - - &320 + - &324 name: epss_percentage in: query description: |- @@ -17288,7 +17288,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &579 + - &580 name: has in: query description: |- @@ -17302,7 +17302,7 @@ paths: type: string enum: - patch - - &321 + - &325 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -17312,7 +17312,7 @@ paths: enum: - development - runtime - - &322 + - &326 name: sort in: query description: |- @@ -17338,7 +17338,7 @@ paths: application/json: schema: type: array - items: &323 + items: &327 type: object description: A Dependabot alert. properties: @@ -17405,7 +17405,7 @@ paths: - direct - transitive - - security_advisory: &580 + security_advisory: &581 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -17641,7 +17641,7 @@ paths: dismissal. maxLength: 280 fixed_at: *129 - auto_dismissed_at: &581 + auto_dismissed_at: &582 type: - string - 'null' @@ -17668,7 +17668,7 @@ paths: - repository additionalProperties: false examples: - default: &324 + default: &328 value: - number: 2 state: dismissed @@ -18449,7 +18449,7 @@ paths: type: array items: *134 examples: - default: &198 + default: &199 value: - id: 1 name: Justice League @@ -18786,7 +18786,7 @@ paths: - name - created_on examples: - default: &425 + default: &428 value: total_count: 2 network_configurations: @@ -19009,7 +19009,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *39 - - &426 + - &429 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -19021,7 +19021,7 @@ paths: description: Response content: application/json: - schema: &427 + schema: &430 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -19060,7 +19060,7 @@ paths: - subnet_id - region examples: - default: &428 + default: &431 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -19894,7 +19894,7 @@ paths: required: true content: application/json: - schema: &394 + schema: &397 title: Custom Property Set Payload description: Custom property set payload type: object @@ -21023,7 +21023,7 @@ paths: conditions: anyOf: - *151 - - &398 + - &401 title: Organization ruleset conditions type: object description: |- @@ -21073,7 +21073,7 @@ paths: - object rules: type: array - items: &701 + items: &703 title: Repository Rule type: object description: A repository rule. @@ -21082,7 +21082,7 @@ paths: - *160 - *161 - *162 - - &698 + - &700 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -21176,7 +21176,7 @@ paths: - *176 - *177 - *178 - - &699 + - &701 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. @@ -21432,7 +21432,7 @@ paths: type: string format: date-time examples: - default: &401 + default: &404 value: - version_id: 3 actor: @@ -21485,7 +21485,7 @@ paths: description: Response content: application/json: - schema: &402 + schema: &405 allOf: - *183 - type: object @@ -21540,7 +21540,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *39 - - &403 + - &406 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -21551,7 +21551,7 @@ paths: enum: - open - resolved - - &404 + - &407 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -21561,7 +21561,7 @@ paths: required: false schema: type: string - - &405 + - &408 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -21570,7 +21570,7 @@ paths: required: false schema: type: string - - &406 + - &409 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. @@ -21586,7 +21586,7 @@ paths: - *17 - *102 - *103 - - &407 + - &410 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -21595,7 +21595,7 @@ paths: required: false schema: type: string - - &408 + - &411 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -21604,7 +21604,7 @@ paths: schema: type: boolean default: false - - &409 + - &412 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -21613,7 +21613,7 @@ paths: schema: type: boolean default: false - - &410 + - &413 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -21629,7 +21629,7 @@ paths: application/json: schema: type: array - items: &411 + items: &414 type: object properties: number: *119 @@ -21645,14 +21645,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &713 + state: &715 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: &714 + resolution: &716 type: - string - 'null' @@ -21759,14 +21759,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &715 + - &717 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &717 + - &719 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -21823,7 +21823,7 @@ paths: - blob_url - commit_sha - commit_url - - &718 + - &720 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. @@ -21884,7 +21884,7 @@ paths: - page_url - commit_sha - commit_url - - &719 + - &721 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -21899,7 +21899,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &720 + - &722 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -21914,7 +21914,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &721 + - &723 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -21929,7 +21929,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &722 + - &724 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -21944,7 +21944,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &723 + - &725 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -21959,7 +21959,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &724 + - &726 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -21974,7 +21974,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &725 + - &727 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. @@ -21989,7 +21989,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &726 + - &728 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. @@ -22004,7 +22004,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &727 + - &729 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. @@ -22019,7 +22019,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &728 + - &730 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. @@ -22034,7 +22034,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &729 + - &731 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 @@ -22059,7 +22059,7 @@ paths: - type: 'null' - *4 examples: - default: &412 + default: &415 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -22268,7 +22268,7 @@ paths: description: Response content: application/json: - schema: &413 + schema: &416 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -22355,7 +22355,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *185 examples: - default: &414 + default: &417 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -22499,7 +22499,7 @@ paths: description: Response content: application/json: - schema: &416 + schema: &419 type: object properties: total_minutes_used: @@ -22569,7 +22569,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &417 + default: &420 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -22600,7 +22600,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *39 - - &418 + - &421 name: advanced_security_product in: query description: | @@ -22620,7 +22620,7 @@ paths: description: Success content: application/json: - schema: &419 + schema: &422 type: object properties: total_advanced_security_committers: @@ -22683,7 +22683,7 @@ paths: required: - repositories examples: - default: &420 + default: &423 value: total_advanced_security_committers: 2 total_count: 2 @@ -22710,6 +22710,724 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: billing + "/enterprises/{enterprise}/settings/billing/budgets": + get: + summary: Get all budgets + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets all budgets for an enterprise. The authenticated user must be an enterprise admin or billing manager. + tags: + - billing + operationId: billing/get-all-budgets + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-all-budgets + parameters: + - *39 + responses: + '200': &236 + description: Response when getting all budgets + content: + application/json: + schema: + type: object + properties: + budgets: + type: array + items: + type: object + properties: + id: + type: string + description: The unique identifier for the budget + examples: + - 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: + type: string + description: The type of pricing for the budget + enum: + - SkuPricing + - ProductPricing + examples: + - SkuPricing + budget_amount: + type: integer + description: The budget amount limit in whole dollars. For + license-based products, this represents the number of + licenses. + prevent_further_usage: + type: boolean + description: The type of limit enforcement for the budget + examples: + - true + budget_scope: + type: string + description: The scope of the budget (enterprise, organization, + repository, cost center) + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity for the budget (enterprise + does not require a name). + examples: + - octocat/hello-world + budget_product_sku: + type: string + description: A single product or sku to apply the budget + to. + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + examples: + - mona + - lisa + required: + - will_alert + - alert_recipients + required: + - id + - budget_type + - budget_product_sku + - budget_scope + - budget_amount + - prevent_further_usage + - budget_alerting + description: Array of budget objects for the enterprise + required: + - budgets + examples: + default: + value: + budgets: + - id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_skus: + - actions + budget_scope: enterprise + budget_amount: 1000.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - enterprise-admin + - billing-manager + - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 + budget_type: SkuPricing + budget_product_skus: + - actions_linux + budget_scope: organization + budget_amount: 500.0 + prevent_further_usage: false + budget_alerting: + will_alert: true + alert_recipients: + - org-owner + - id: 6ba7b810-9dad-11d1-80b4-00c04fd430c8 + budget_type: ProductPricing + budget_product_skus: + - packages + budget_scope: cost_center + budget_amount: 250.0 + prevent_further_usage: true + budget_alerting: + will_alert: false + alert_recipients: [] + '404': *6 + '403': *27 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + post: + summary: Create a budget + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise. + tags: + - billing + operationId: billing/create-budget + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#create-a-budget + parameters: + - *39 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - budget_amount + - prevent_further_usage + - budget_alerting + - budget_scope + - budget_type + properties: + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + budget_alerting: + type: object + required: + - will_alert + - alert_recipients + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + default: '' + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered in the + budget + examples: + create-budget: + summary: Create budget example + value: + budget_amount: 200 + prevent_further_usage: true + budget_scope: enterprise + budget_entity_name: '' + budget_type: ProductPricing + budget_product_sku: actions + budget_alerting: + will_alert: false + alert_recipients: [] + responses: + '200': + description: Budget created successfully + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the result of the create operation + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + enum: + - enterprise + - organization + - repository + - cost_center + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + examples: + - example-repository-name + budget_amount: + type: number + format: float + description: The budget amount in dollars + minimum: 0.0 + examples: + - 100.0 + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the + budget is exceeded + examples: + - true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + examples: + - actions_linux + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + examples: + - ProductPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + examples: + - mona + - lisa + required: + - message + - budget + examples: + create-budget: + value: + message: Budget successfully created. + '400': *14 + '401': *23 + '403': *27 + '404': + description: Feature not enabled + content: + application/json: + schema: *3 + examples: + feature-not-enabled: + value: + message: Not Found + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#create-a-budget + '422': *15 + '500': + description: Internal server error + content: + application/json: + schema: *3 + examples: + server-error: + value: + message: Unable to create budget. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#create-a-budget + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": + get: + summary: Get a budget by ID + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager. + tags: + - billing + operationId: billing/get-budget + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-a-budget-by-id + parameters: + - *39 + - &187 + name: budget_id + description: The ID corresponding to the budget. + in: path + required: true + schema: + type: string + responses: + '200': &237 + description: Response when updating a budget + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + enum: + - enterprise + - organization + - repository + - cost_center + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + examples: + - octocat/hello-world + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + examples: + - true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + examples: + - actions_linux + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + examples: + - ProductPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + examples: + - mona + - lisa + required: + - id + - budget_amount + - prevent_further_usage + - budget_product_sku + - budget_type + - budget_alerting + - budget_scope + - budget_entity_name + examples: + default: + value: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa + '400': *14 + '404': *6 + '403': *27 + '500': *38 + '503': *184 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + patch: + summary: Update a budget + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise. + tags: + - billing + operationId: billing/update-budget + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#update-a-budget + parameters: + - name: enterprise + in: path + required: true + schema: + type: string + description: The slug version of the enterprise name + - name: budget_id + in: path + required: true + schema: + type: string + description: The unique identifier of the budget + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered in the + budget + examples: + update-budget: + summary: Update budget example + value: + prevent_further_usage: false + budget_amount: 10 + budget_alerting: + will_alert: false + alert_recipients: [] + responses: + '200': + description: Budget updated successfully + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the result of the update operation + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + enum: + - enterprise + - organization + - repository + - cost_center + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + examples: + - example-repository-name + budget_amount: + type: number + format: float + description: The budget amount in dollars + minimum: 0.0 + examples: + - 100.0 + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the + budget is exceeded + examples: + - true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + examples: + - actions_linux + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + examples: + - ProductPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + examples: + - mona + - lisa + required: + - budget + - message + examples: + update-budget: + value: + message: Budget successfully updated. + budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b + '400': *14 + '401': *23 + '403': *27 + '404': + description: Budget not found or feature not enabled + content: + application/json: + schema: *3 + examples: + budget-not-found: + value: + message: Budget with ID 550e8400-e29b-41d4-a716-446655440000 not + found. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + feature-not-enabled: + value: + message: Not Found + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + '422': *15 + '500': + description: Internal server error + content: + application/json: + schema: *3 + examples: + server-error: + value: + message: Unable to retrieve budget. + documentation_url: https://docs.github.com/rest/enterprise-admin/billing#update-a-budget + '503': + description: Service unavailable + content: + application/json: + schema: *3 + examples: + server-error: + value: + message: Unable to update budget. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + delete: + summary: Delete a budget + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Deletes 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/enhanced-billing#delete-a-budget + parameters: + - *39 + - *187 + responses: + '200': &238 + 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': *14 + '404': *6 + '403': *27 + '500': *38 + '503': *184 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing "/enterprises/{enterprise}/settings/billing/cost-centers": get: summary: Get all cost centers for an enterprise @@ -22934,7 +23652,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-a-cost-center-by-id parameters: - *39 - - &189 + - &190 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -22946,7 +23664,7 @@ paths: description: Response when getting a cost center content: application/json: - schema: &187 + schema: &188 type: object properties: id: @@ -22986,7 +23704,7 @@ paths: - name - resources examples: - default: &188 + default: &189 value: id: 2eeb8ffe-6903-11ee-8c99-0242ac120002 name: Cost Center Name @@ -23050,9 +23768,9 @@ paths: description: Response when updating a cost center content: application/json: - schema: *187 + schema: *188 examples: - default: *188 + default: *189 '400': *14 '403': *27 '404': *6 @@ -23076,7 +23794,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#delete-a-cost-center parameters: - *39 - - *189 + - *190 responses: '200': description: Response when deleting a cost center @@ -23136,7 +23854,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#add-resources-to-a-cost-center parameters: - *39 - - *189 + - *190 requestBody: required: true content: @@ -23229,7 +23947,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#remove-resources-from-a-cost-center parameters: - *39 - - *189 + - *190 requestBody: required: true content: @@ -23307,7 +24025,7 @@ paths: description: Response content: application/json: - schema: &421 + schema: &424 type: object properties: total_gigabytes_bandwidth_used: @@ -23325,7 +24043,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &422 + default: &425 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -23350,7 +24068,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-premium-request-usage-report-for-an-enterprise parameters: - *39 - - &190 + - &191 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, @@ -23359,7 +24077,7 @@ paths: required: false schema: type: integer - - &192 + - &193 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 @@ -23368,7 +24086,7 @@ paths: required: false schema: type: integer - - &191 + - &192 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 @@ -23377,7 +24095,7 @@ paths: required: false schema: type: integer - - &193 + - &194 name: organization description: The organization name to query usage for. The name is not case sensitive. @@ -23385,21 +24103,21 @@ paths: required: false schema: type: string - - &235 + - &239 name: user description: The user name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &236 + - &240 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &194 + - &195 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -23569,7 +24287,7 @@ paths: description: Response content: application/json: - schema: &423 + schema: &426 type: object properties: days_left_in_billing_cycle: @@ -23587,7 +24305,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &424 + default: &427 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -23612,8 +24330,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - *39 - - *190 - - &237 + - *191 + - &241 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 @@ -23622,7 +24340,7 @@ paths: required: false schema: type: integer - - *191 + - *192 - name: cost_center_id description: The ID corresponding to a cost center. The default value is no cost center. @@ -23635,7 +24353,7 @@ paths: description: Response when getting a billing usage report content: application/json: - schema: &238 + schema: &242 type: object properties: usageItems: @@ -23688,7 +24406,7 @@ paths: - netAmount - organizationName examples: - default: &239 + default: &243 value: usageItems: - date: '2023-08-01' @@ -23713,7 +24431,7 @@ paths: subcategory: billing "/enterprises/{enterprise}/settings/billing/usage/summary": get: - summary: Get billing usage summary report for an enterprise + summary: Get billing usage summary for an enterprise description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. @@ -23726,22 +24444,22 @@ paths: operationId: billing/get-github-billing-usage-summary-report-ghe externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-summary-report-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-summary-for-an-enterprise parameters: - *39 - - *190 - - *192 - *191 - *193 - - &240 + - *192 + - *194 + - &244 name: repository description: The repository name to query for usage in the format owner/repository. in: query required: false schema: type: string - - *194 - - &241 + - *195 + - &245 name: sku description: The SKU to query for usage. in: query @@ -23757,7 +24475,7 @@ paths: type: string responses: '200': - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -23940,13 +24658,13 @@ paths: application/json: schema: type: array - items: *195 + items: *196 examples: - default: *196 + default: *197 '500': *38 '403': *27 '404': *6 - '422': *197 + '422': *198 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -23975,7 +24693,7 @@ paths: type: array items: *134 examples: - default: *198 + default: *199 headers: Link: *41 '403': *27 @@ -24054,7 +24772,7 @@ paths: application/json: schema: *134 examples: - default: *198 + default: *199 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24072,7 +24790,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *39 - - &199 + - &200 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -24091,7 +24809,7 @@ paths: type: array items: *4 examples: - default: &200 + default: &201 value: - login: octocat id: 1 @@ -24130,7 +24848,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *39 - - *199 + - *200 requestBody: required: true content: @@ -24161,7 +24879,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24179,7 +24897,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *39 - - *199 + - *200 requestBody: required: true content: @@ -24210,7 +24928,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24228,7 +24946,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *39 - - *199 + - *200 - *132 responses: '200': @@ -24237,7 +24955,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &201 + exampleKey1: &202 value: login: octocat id: 1 @@ -24273,7 +24991,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *39 - - *199 + - *200 - *132 responses: '201': @@ -24282,7 +25000,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *201 + exampleKey1: *202 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24300,7 +25018,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *39 - - *199 + - *200 - *132 responses: '204': @@ -24323,7 +25041,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments parameters: - *39 - - *199 + - *200 - *17 - *19 responses: @@ -24335,7 +25053,7 @@ paths: type: array items: *67 examples: - default: &202 + default: &203 value: login: github id: 1 @@ -24366,7 +25084,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments parameters: - *39 - - *199 + - *200 requestBody: required: true content: @@ -24396,7 +25114,7 @@ paths: type: array items: *67 examples: - default: &234 + default: &235 value: - login: github id: 1 @@ -24427,7 +25145,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments parameters: - *39 - - *199 + - *200 requestBody: required: true content: @@ -24468,7 +25186,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment parameters: - *39 - - *199 + - *200 - *81 responses: '200': @@ -24477,7 +25195,7 @@ paths: application/json: schema: *67 examples: - default: *202 + default: *203 '404': description: The team is not assigned to the organization x-github: @@ -24496,7 +25214,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment parameters: - *39 - - *199 + - *200 - *81 responses: '201': @@ -24505,7 +25223,7 @@ paths: application/json: schema: *67 examples: - default: *202 + default: *203 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24522,7 +25240,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment parameters: - *39 - - *199 + - *200 - *81 responses: '204': @@ -24547,7 +25265,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *39 - - &203 + - &204 name: team_slug description: The slug of the team name. in: path @@ -24561,7 +25279,7 @@ paths: application/json: schema: *134 examples: - default: *198 + default: *199 headers: Link: *41 '403': *27 @@ -24581,7 +25299,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *39 - - *203 + - *204 requestBody: required: true content: @@ -24641,7 +25359,7 @@ paths: application/json: schema: *134 examples: - default: *198 + default: *199 headers: Link: *41 '403': *27 @@ -24664,7 +25382,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *39 - - *203 + - *204 responses: '204': description: Response @@ -24763,7 +25481,7 @@ paths: application/json: schema: type: array - items: &229 + items: &230 title: Event description: Event type: object @@ -24774,7 +25492,7 @@ paths: type: - string - 'null' - actor: &204 + actor: &205 title: Actor description: Actor type: object @@ -24815,13 +25533,13 @@ paths: - id - name - url - org: *204 + org: *205 payload: type: object properties: action: type: string - issue: &218 + issue: &219 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -24942,7 +25660,7 @@ paths: milestone: anyOf: - type: 'null' - - &387 + - &390 title: Milestone description: A collection of related issues and pull requests. @@ -25114,7 +25832,7 @@ paths: timeline_url: type: string format: uri - type: &351 + type: &355 title: Issue Type description: The type of issue. type: @@ -25172,7 +25890,7 @@ paths: anyOf: - type: 'null' - *5 - author_association: &205 + author_association: &206 title: author_association type: string description: How the author is associated with the repository. @@ -25187,7 +25905,7 @@ paths: - OWNER examples: - OWNER - reactions: &206 + reactions: &207 title: Reaction Rollup type: object properties: @@ -25223,7 +25941,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &773 + sub_issues_summary: &775 title: Sub-issues Summary type: object properties: @@ -25244,7 +25962,7 @@ paths: - string - 'null' format: uri - issue_dependencies_summary: &774 + issue_dependencies_summary: &776 title: Issue Dependencies Summary type: object properties: @@ -25263,7 +25981,7 @@ paths: - total_blocking issue_field_values: type: array - items: &775 + items: &777 title: Issue Field Value description: A value assigned to an issue field type: object @@ -25358,7 +26076,7 @@ paths: - user - created_at - updated_at - comment: &636 + comment: &638 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -25408,12 +26126,12 @@ paths: issue_url: type: string format: uri - author_association: *205 + author_association: *206 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *206 + reactions: *207 required: - id - node_id @@ -25591,7 +26309,7 @@ paths: _links: type: object properties: - timeline: &207 + timeline: &208 title: Link With Type description: Hypermedia Link with Type type: object @@ -25603,17 +26321,17 @@ paths: required: - href - type - user: *207 - security_advisories: *207 - current_user: *207 - current_user_public: *207 - current_user_actor: *207 - current_user_organization: *207 + user: *208 + security_advisories: *208 + current_user: *208 + current_user_public: *208 + current_user_actor: *208 + current_user_organization: *208 current_user_organizations: type: array - items: *207 - repository_discussions: *207 - repository_discussions_category: *207 + items: *208 + repository_discussions: *208 + repository_discussions_category: *208 required: - timeline - user @@ -25675,7 +26393,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *208 + - *209 - *17 - *19 responses: @@ -25685,7 +26403,7 @@ paths: application/json: schema: type: array - items: &209 + items: &210 title: Base Gist description: Base Gist type: object @@ -25782,7 +26500,7 @@ paths: - created_at - updated_at examples: - default: &210 + default: &211 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -25906,7 +26624,7 @@ paths: description: Response content: application/json: - schema: &211 + schema: &212 title: Gist Simple description: Gist Simple type: object @@ -25924,7 +26642,7 @@ paths: url: type: string format: uri - user: &787 + user: &789 title: Public User description: Public User type: object @@ -26298,7 +27016,7 @@ paths: truncated: type: boolean examples: - default: &212 + default: &213 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -26402,7 +27120,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *208 + - *209 - *17 - *19 responses: @@ -26412,9 +27130,9 @@ paths: application/json: schema: type: array - items: *209 + items: *210 examples: - default: *210 + default: *211 headers: Link: *41 '422': *15 @@ -26436,7 +27154,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *208 + - *209 - *17 - *19 responses: @@ -26446,9 +27164,9 @@ paths: application/json: schema: type: array - items: *209 + items: *210 examples: - default: *210 + default: *211 headers: Link: *41 '401': *23 @@ -26476,7 +27194,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &213 + - &214 name: gist_id description: The unique identifier of the gist. in: path @@ -26488,10 +27206,10 @@ paths: description: Response content: application/json: - schema: *211 + schema: *212 examples: - default: *212 - '403': &216 + default: *213 + '403': &217 description: Forbidden Gist content: application/json: @@ -26540,7 +27258,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *213 + - *214 requestBody: required: true content: @@ -26604,9 +27322,9 @@ paths: description: Response content: application/json: - schema: *211 + schema: *212 examples: - updateGist: *212 + updateGist: *213 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -26764,7 +27482,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *213 + - *214 responses: '204': description: Response @@ -26793,7 +27511,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *213 + - *214 - *17 - *19 responses: @@ -26803,7 +27521,7 @@ paths: application/json: schema: type: array - items: &214 + items: &215 title: Gist Comment description: A comment made to a gist. type: object @@ -26841,7 +27559,7 @@ paths: format: date-time examples: - '2011-04-18T23:23:56Z' - author_association: *205 + author_association: *206 required: - url - id @@ -26906,7 +27624,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *213 + - *214 requestBody: required: true content: @@ -26932,9 +27650,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *215 examples: - default: &215 + default: &216 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -26992,8 +27710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *213 - - &217 + - *214 + - &218 name: comment_id description: The unique identifier of the comment. in: path @@ -27006,12 +27724,12 @@ paths: description: Response content: application/json: - schema: *214 + schema: *215 examples: - default: *215 + default: *216 '304': *35 '404': *6 - '403': *216 + '403': *217 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27033,8 +27751,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *213 - - *217 + - *214 + - *218 requestBody: required: true content: @@ -27060,9 +27778,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *215 examples: - default: *215 + default: *216 '404': *6 x-github: githubCloudOnly: false @@ -27079,8 +27797,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *213 - - *217 + - *214 + - *218 responses: '204': description: Response @@ -27103,7 +27821,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *213 + - *214 - *17 - *19 responses: @@ -27204,7 +27922,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *213 + - *214 - *17 - *19 responses: @@ -27214,7 +27932,7 @@ paths: application/json: schema: type: array - items: *211 + items: *212 examples: default: value: @@ -27279,13 +27997,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *213 + - *214 responses: '201': description: Response content: application/json: - schema: *209 + schema: *210 examples: default: value: @@ -27356,7 +28074,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *213 + - *214 responses: '204': description: Response if gist is starred @@ -27386,7 +28104,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *213 + - *214 responses: '204': description: Response @@ -27408,7 +28126,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *213 + - *214 responses: '204': description: Response @@ -27437,7 +28155,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *213 + - *214 - name: sha in: path required: true @@ -27448,9 +28166,9 @@ paths: description: Response content: application/json: - schema: *211 + schema: *212 examples: - default: *212 + default: *213 '422': *15 '404': *6 '403': *27 @@ -27819,7 +28537,7 @@ paths: - closed - all default: open - - &354 + - &358 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -27838,7 +28556,7 @@ paths: - comments default: created - *104 - - *208 + - *209 - name: collab in: query required: false @@ -27868,9 +28586,9 @@ paths: application/json: schema: type: array - items: *218 + items: *219 examples: - default: &355 + default: &359 value: - id: 1 node_id: MDU6SXNzdWUx @@ -28150,7 +28868,7 @@ paths: application/json: schema: type: array - items: *219 + items: *220 examples: default: value: @@ -28448,7 +29166,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &220 + X-CommonMarker-Version: &221 example: 0.17.4 schema: type: string @@ -28503,7 +29221,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *220 + X-CommonMarker-Version: *221 content: text/html: schema: @@ -28532,7 +29250,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: - - &223 + - &224 name: account_id description: account_id parameter in: path @@ -28544,7 +29262,7 @@ paths: description: Response content: application/json: - schema: &222 + schema: &223 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -28578,7 +29296,7 @@ paths: - 'null' id: type: integer - plan: &221 + plan: &222 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -28681,7 +29399,7 @@ paths: - 'null' updated_at: type: string - plan: *221 + plan: *222 required: - url - id @@ -28689,7 +29407,7 @@ paths: - login - marketplace_purchase examples: - default: &224 + default: &225 value: url: https://api.github.com/orgs/github type: Organization @@ -28774,9 +29492,9 @@ paths: application/json: schema: type: array - items: *221 + items: *222 examples: - default: &225 + default: &226 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -28816,14 +29534,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &226 + - &227 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &227 + - &228 name: sort description: The property to sort the results by. in: query @@ -28853,9 +29571,9 @@ paths: application/json: schema: type: array - items: *222 + items: *223 examples: - default: &228 + default: &229 value: - url: https://api.github.com/orgs/github type: Organization @@ -28929,15 +29647,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: - - *223 + - *224 responses: '200': description: Response content: application/json: - schema: *222 + schema: *223 examples: - default: *224 + default: *225 '404': description: Not Found when the account has not purchased the listing '401': *23 @@ -28969,9 +29687,9 @@ paths: application/json: schema: type: array - items: *221 + items: *222 examples: - default: *225 + default: *226 headers: Link: *41 '401': *23 @@ -28994,8 +29712,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *226 - *227 + - *228 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -29015,9 +29733,9 @@ paths: application/json: schema: type: array - items: *222 + items: *223 examples: - default: *228 + default: *229 headers: Link: *41 '401': *23 @@ -29282,14 +30000,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: - - &448 + - &451 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &449 + - &452 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -29306,7 +30024,7 @@ paths: application/json: schema: type: array - items: *229 + items: *230 examples: default: value: @@ -29351,7 +30069,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &462 + '301': &463 description: Moved permanently content: application/json: @@ -29373,7 +30091,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &665 + - &667 name: all description: If `true`, show notifications marked as read. in: query @@ -29381,7 +30099,7 @@ paths: schema: type: boolean default: false - - &666 + - &668 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -29390,8 +30108,8 @@ paths: schema: type: boolean default: false - - *208 - - &667 + - *209 + - &669 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: @@ -29416,14 +30134,14 @@ paths: application/json: schema: type: array - items: &230 + items: &231 title: Thread description: Thread type: object properties: id: type: string - repository: &269 + repository: &273 title: Minimal Repository description: Minimal Repository type: object @@ -29762,7 +30480,7 @@ paths: type: boolean examples: - false - security_and_analysis: &395 + security_and_analysis: &398 type: - object - 'null' @@ -29935,7 +30653,7 @@ paths: - url - subscription_url examples: - default: &668 + default: &670 value: - id: '1' repository: @@ -30101,7 +30819,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &231 + - &232 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 @@ -30115,7 +30833,7 @@ paths: description: Response content: application/json: - schema: *230 + schema: *231 examples: default: value: @@ -30218,7 +30936,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *231 + - *232 responses: '205': description: Reset Content @@ -30241,7 +30959,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *231 + - *232 responses: '204': description: No content @@ -30264,13 +30982,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: - - *231 + - *232 responses: '200': description: Response content: application/json: - schema: &232 + schema: &233 title: Thread Subscription description: Thread Subscription type: object @@ -30314,7 +31032,7 @@ paths: - url - subscribed examples: - default: &233 + default: &234 value: subscribed: true ignored: false @@ -30345,7 +31063,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *231 + - *232 requestBody: required: false content: @@ -30366,9 +31084,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *233 examples: - default: *233 + default: *234 '304': *35 '403': *27 '401': *23 @@ -30391,7 +31109,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *231 + - *232 responses: '204': description: Response @@ -30488,7 +31206,7 @@ paths: type: array items: *67 examples: - default: *234 + default: *235 headers: Link: example: ; rel="next" @@ -30540,7 +31258,7 @@ paths: - 3 custom_roles: type: array - items: &312 + items: &316 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -30589,7 +31307,7 @@ paths: - created_at - updated_at examples: - default: &313 + default: &317 value: id: 8030 name: Security Engineer @@ -30916,7 +31634,7 @@ paths: type: array items: *145 examples: - default: &674 + default: &676 value: - property_name: environment value: production @@ -30966,7 +31684,7 @@ paths: required: - properties examples: - default: &675 + default: &677 value: properties: - property_name: environment @@ -30987,6 +31705,264 @@ paths: enabledForGitHubApps: true category: orgs subcategory: custom-properties-for-orgs + "/organizations/{org}/settings/billing/budgets": + get: + summary: Get all budgets for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-all-budgets-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-all-budgets-for-an-organization + parameters: + - *81 + responses: + '200': *236 + '404': *6 + '403': *27 + '500': *38 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing + "/organizations/{org}/settings/billing/budgets/{budget_id}": + get: + summary: Get a budget by ID for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a budget by ID. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-a-budget-by-id-for-an-organization + parameters: + - *81 + - *187 + responses: + '200': *237 + '400': *14 + '404': *6 + '403': *27 + '500': *38 + '503': *184 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing + patch: + summary: Update a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/update-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#update-a-budget-for-an-organization + parameters: + - *81 + - *187 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered in the + budget + examples: + update-budget: + summary: Update budget example + value: + prevent_further_usage: false + budget_amount: 10 + budget_alerting: + will_alert: false + alert_recipients: [] + responses: + '200': + description: Budget updated successfully + content: + application/json: + schema: + type: object + properties: + message: + type: string + examples: + - Budget successfully updated. + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_amount: + type: number + format: float + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the + budget is exceeded + budget_alerting: + type: object + required: + - will_alert + - alert_recipients + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + default: '' + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered + in the budget + examples: + update-budget: + value: + message: Budget successfully updated. + id: 550e8400-e29b-41d4-a716-446655440000 + '400': *14 + '401': *23 + '403': *27 + '404': + description: Budget not found or feature not enabled + content: + application/json: + schema: *3 + examples: + budget-not-found: + value: + message: Budget with ID 550e8400-e29b-41d4-a716-446655440000 not + found. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + feature-not-enabled: + value: + message: Not Found + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + '422': *15 + '500': + description: Internal server error + content: + application/json: + schema: *3 + examples: + server-error: + value: + message: Unable to update budget. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + delete: + summary: Delete a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/delete-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#delete-a-budget-for-an-organization + parameters: + - *81 + - *187 + responses: + '200': *238 + '400': *14 + '404': *6 + '403': *27 + '500': *38 + '503': *184 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization @@ -31002,12 +31978,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-an-organization parameters: - *81 - - *190 - - *192 - *191 - - *235 - - *236 - - *194 + - *193 + - *192 + - *239 + - *240 + - *195 responses: '200': description: Response when getting a billing premium request usage report @@ -31139,17 +32115,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - *81 - - *190 - - *237 - *191 + - *241 + - *192 responses: '200': description: Billing usage report response for an organization content: application/json: - schema: *238 + schema: *242 examples: - default: *239 + default: *243 '400': *14 '403': *27 '500': *38 @@ -31161,7 +32137,7 @@ paths: subcategory: enhanced-billing "/organizations/{org}/settings/billing/usage/summary": get: - summary: Get billing usage summary report for an organization + summary: Get billing usage summary for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. @@ -31174,18 +32150,18 @@ paths: operationId: billing/get-github-billing-usage-summary-report-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-report-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-for-an-organization parameters: - *81 - - *190 - - *192 - *191 - - *240 - - *194 - - *241 + - *193 + - *192 + - *244 + - *195 + - *245 responses: '200': - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -31319,7 +32295,7 @@ paths: description: Response content: application/json: - schema: &242 + schema: &246 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -31729,7 +32705,7 @@ paths: - updated_at - archived_at examples: - default-response: &243 + default-response: &247 value: login: github id: 1 @@ -32055,17 +33031,17 @@ paths: description: Response content: application/json: - schema: *242 + schema: *246 examples: - default: *243 + default: *247 '422': description: Validation failed content: application/json: schema: oneOf: - - *244 - - *245 + - *248 + - *249 '409': *112 x-github: githubCloudOnly: false @@ -32120,9 +33096,9 @@ paths: description: Response content: application/json: - schema: *246 + schema: *250 examples: - default: *247 + default: *251 headers: Link: *41 x-github: @@ -32163,7 +33139,7 @@ paths: type: integer repository_cache_usages: type: array - items: &467 + items: &468 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -32241,7 +33217,7 @@ paths: type: array items: *42 examples: - default: *248 + default: *252 headers: Link: *41 x-github: @@ -32408,7 +33384,7 @@ paths: application/json: schema: *43 examples: - default: *249 + default: *253 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32500,7 +33476,7 @@ paths: application/json: schema: *46 examples: - default: *250 + default: *254 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32619,9 +33595,9 @@ paths: description: Response content: application/json: - schema: *251 + schema: *255 examples: - default: *252 + default: *256 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32657,7 +33633,7 @@ paths: type: array items: *50 examples: - default: *253 + default: *257 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32846,7 +33822,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &254 + schema: &258 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -32860,7 +33836,7 @@ paths: required: - include_claim_keys examples: - default: &255 + default: &259 value: include_claim_keys: - repo @@ -32887,15 +33863,15 @@ paths: required: true content: application/json: - schema: *254 + schema: *258 examples: - default: *255 + default: *259 responses: '201': description: Empty response content: application/json: - schema: &280 + schema: &284 title: Empty Object description: An object without any properties. type: object @@ -32934,7 +33910,7 @@ paths: schema: type: object properties: - enabled_repositories: &257 + enabled_repositories: &261 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -32948,7 +33924,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *54 - selected_actions_url: *256 + selected_actions_url: *260 sha_pinning_required: *55 required: - enabled_repositories @@ -32990,7 +33966,7 @@ paths: schema: type: object properties: - enabled_repositories: *257 + enabled_repositories: *261 allowed_actions: *54 sha_pinning_required: *55 required: @@ -33026,7 +34002,7 @@ paths: description: Response content: application/json: - schema: *258 + schema: *262 examples: response: summary: Example response @@ -33057,7 +34033,7 @@ paths: required: true content: application/json: - schema: *259 + schema: *263 examples: application/json: value: @@ -33095,7 +34071,7 @@ paths: application/json: schema: *56 examples: - default: *260 + default: *264 '404': *6 x-github: enabledForGitHubApps: true @@ -33152,7 +34128,7 @@ paths: description: Response content: application/json: - schema: *261 + schema: *265 examples: default: *57 '403': *27 @@ -33177,7 +34153,7 @@ paths: required: true content: application/json: - schema: *262 + schema: *266 examples: default: *57 responses: @@ -33229,7 +34205,7 @@ paths: type: array items: *72 examples: - default: &264 + default: &268 value: total_count: 1 repositories: @@ -33414,7 +34390,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *81 - - &263 + - &267 name: repository_id description: The unique identifier of the repository. in: path @@ -33443,7 +34419,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *81 - - *263 + - *267 responses: '204': description: Response @@ -33639,7 +34615,7 @@ paths: type: array items: *72 examples: - default: *264 + default: *268 '403': *27 '404': *6 x-github: @@ -33708,7 +34684,7 @@ paths: 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: - *81 - - *263 + - *267 responses: '204': description: No content @@ -33735,7 +34711,7 @@ paths: 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: - *81 - - *263 + - *267 responses: '204': description: No content @@ -33769,7 +34745,7 @@ paths: description: Response content: application/json: - schema: *265 + schema: *269 examples: default: *63 x-github: @@ -33803,7 +34779,7 @@ paths: required: false content: application/json: - schema: *266 + schema: *270 examples: default: *63 x-github: @@ -33850,7 +34826,7 @@ paths: type: number runner_groups: type: array - items: &267 + items: &271 type: object properties: id: @@ -34040,9 +35016,9 @@ paths: description: Response content: application/json: - schema: *267 + schema: *271 examples: - default: &268 + default: &272 value: id: 2 name: octo-runner-group @@ -34084,7 +35060,7 @@ paths: description: Response content: application/json: - schema: *267 + schema: *271 examples: default: value: @@ -34177,9 +35153,9 @@ paths: description: Response content: application/json: - schema: *267 + schema: *271 examples: - default: *268 + default: *272 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -34243,7 +35219,7 @@ paths: type: array items: *42 examples: - default: *248 + default: *252 headers: Link: *41 x-github: @@ -34284,9 +35260,9 @@ paths: type: number repositories: type: array - items: *269 + items: *273 examples: - default: &790 + default: &792 value: total_count: 1 repositories: @@ -34585,7 +35561,7 @@ paths: parameters: - *81 - *66 - - *263 + - *267 responses: '204': description: Response @@ -34609,7 +35585,7 @@ paths: parameters: - *81 - *66 - - *263 + - *267 responses: '204': description: Response @@ -34827,9 +35803,9 @@ paths: application/json: schema: type: array - items: *270 + items: *274 examples: - default: *271 + default: *275 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34894,7 +35870,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *272 + '201': *276 '404': *6 '422': *7 '409': *112 @@ -34933,7 +35909,7 @@ paths: application/json: schema: *73 examples: - default: *273 + default: *277 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34969,7 +35945,7 @@ paths: application/json: schema: *73 examples: - default: *274 + default: *278 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35000,7 +35976,7 @@ paths: application/json: schema: *70 examples: - default: *275 + default: *279 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35175,7 +36151,7 @@ paths: - *81 - *69 responses: - '200': *276 + '200': *280 '404': *6 x-github: githubCloudOnly: false @@ -35204,7 +36180,7 @@ paths: parameters: - *81 - *69 - - *277 + - *281 responses: '200': *75 '404': *6 @@ -35249,7 +36225,7 @@ paths: type: integer secrets: type: array - items: &278 + items: &282 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -35330,7 +36306,7 @@ paths: description: Response content: application/json: - schema: &487 + schema: &488 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -35365,7 +36341,7 @@ paths: - key_id - key examples: - default: &488 + default: &489 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -35391,7 +36367,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - *81 - - &279 + - &283 name: secret_name description: The name of the secret. in: path @@ -35403,7 +36379,7 @@ paths: description: Response content: application/json: - schema: *278 + schema: *282 examples: default: value: @@ -35434,7 +36410,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - *81 - - *279 + - *283 requestBody: required: true content: @@ -35491,7 +36467,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -35518,7 +36494,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - *81 - - *279 + - *283 responses: '204': description: Response @@ -35545,7 +36521,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - *81 - - *279 + - *283 - *19 - *17 responses: @@ -35563,9 +36539,9 @@ paths: type: integer repositories: type: array - items: *269 + items: *273 examples: - default: &283 + default: &287 value: total_count: 1 repositories: @@ -35658,7 +36634,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - *81 - - *279 + - *283 requestBody: required: true content: @@ -35711,7 +36687,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - *81 - - *279 + - *283 - name: repository_id in: path required: true @@ -35745,7 +36721,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - *81 - - *279 + - *283 - name: repository_id in: path required: true @@ -35778,7 +36754,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - *81 - - &472 + - &473 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)." @@ -35802,7 +36778,7 @@ paths: type: integer variables: type: array - items: &281 + items: &285 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -35940,7 +36916,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -35966,7 +36942,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - *81 - - &282 + - &286 name: name description: The name of the variable. in: path @@ -35978,7 +36954,7 @@ paths: description: Response content: application/json: - schema: *281 + schema: *285 examples: default: value: @@ -36009,7 +36985,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - *81 - - *282 + - *286 requestBody: required: true content: @@ -36072,7 +37048,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - *81 - - *282 + - *286 responses: '204': description: Response @@ -36099,7 +37075,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - *81 - - *282 + - *286 - *19 - *17 responses: @@ -36117,9 +37093,9 @@ paths: type: integer repositories: type: array - items: *269 + items: *273 examples: - default: *283 + default: *287 '409': description: Response when the visibility of the variable is not set to `selected` @@ -36146,7 +37122,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - *81 - - *282 + - *286 requestBody: required: true content: @@ -36196,7 +37172,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - *81 - - *282 + - *286 - name: repository_id in: path required: true @@ -36231,7 +37207,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - *81 - - *282 + - *286 - name: repository_id in: path required: true @@ -36289,7 +37265,7 @@ paths: required: true content: application/json: - schema: *284 + schema: *288 examples: default: *79 parameters: @@ -36606,12 +37582,12 @@ paths: required: - subject_digests examples: - default: &817 + default: &819 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &818 + withPredicateType: &820 value: subject_digests: - sha256:abc123 @@ -36670,7 +37646,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &819 + default: &821 value: attestations_subject_digests: - sha256:abc: @@ -37019,7 +37995,7 @@ paths: initiator: type: string examples: - default: &501 + default: &502 value: attestations: - bundle: @@ -37145,10 +38121,10 @@ paths: required: false schema: type: string - - *285 - - *286 - - *287 - - *288 + - *289 + - *290 + - *291 + - *292 - *17 responses: '200': @@ -37157,9 +38133,9 @@ paths: application/json: schema: type: array - items: *289 + items: *293 examples: - default: *290 + default: *294 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -37188,7 +38164,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37282,7 +38258,7 @@ paths: subcategory: bypass-requests parameters: - *81 - - &293 + - &297 name: repository_name description: The name of the repository to filter on. in: query @@ -37301,9 +38277,9 @@ paths: application/json: schema: type: array - items: *291 + items: *295 examples: - default: *292 + default: *296 '404': *6 '500': *38 "/orgs/{org}/bypass-requests/secret-scanning": @@ -37327,7 +38303,7 @@ paths: subcategory: delegated-bypass parameters: - *81 - - *293 + - *297 - *97 - *98 - *99 @@ -37341,9 +38317,9 @@ paths: application/json: schema: type: array - items: *294 + items: *298 examples: - default: *295 + default: *299 '404': *6 '500': *38 "/orgs/{org}/campaigns": @@ -37370,7 +38346,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &297 + schema: &301 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -37396,7 +38372,7 @@ paths: application/json: schema: type: array - items: &298 + items: &302 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -37427,7 +38403,7 @@ paths: team_managers: description: The campaign team managers type: array - items: *296 + items: *300 published_at: description: The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. @@ -37446,7 +38422,7 @@ paths: - string - 'null' format: date-time - state: *297 + state: *301 contact_link: description: The contact link of the campaign. type: @@ -37669,9 +38645,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *302 examples: - default: &299 + default: &303 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -37754,9 +38730,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *302 examples: - default: *299 + default: *303 '404': *6 '422': description: Unprocessable Entity @@ -37834,7 +38810,7 @@ paths: - string - 'null' format: uri - state: *297 + state: *301 examples: default: value: @@ -37844,9 +38820,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *302 examples: - default: *299 + default: *303 '400': description: Bad Request content: @@ -37913,8 +38889,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *81 - - *300 - - *301 + - *304 + - *305 - *102 - *103 - *19 @@ -37925,7 +38901,7 @@ paths: be returned. in: query required: false - schema: *302 + schema: *306 - name: sort description: The property by which to sort the results. in: query @@ -37941,7 +38917,7 @@ paths: be returned. in: query required: false - schema: &527 + schema: &528 type: string description: Severity of a code scanning alert. enum: @@ -37959,9 +38935,9 @@ paths: application/json: schema: type: array - items: *303 + items: *307 examples: - default: *304 + default: *308 headers: Link: *41 '404': *6 @@ -38176,7 +39152,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *305 + code_scanning_options: *309 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -38319,7 +39295,7 @@ paths: application/json: schema: *108 examples: - default: *306 + default: *310 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38347,9 +39323,9 @@ paths: description: Response content: application/json: - schema: *307 + schema: *311 examples: - default: *308 + default: *312 '304': *35 '403': *27 '404': *6 @@ -38436,7 +39412,7 @@ paths: application/json: schema: *108 examples: - default: *306 + default: *310 '304': *35 '403': *27 '404': *6 @@ -38858,7 +39834,7 @@ paths: default: value: default_for_new_repos: all - configuration: *306 + configuration: *310 '403': *27 '404': *6 x-github: @@ -38911,13 +39887,13 @@ paths: application/json: schema: type: array - items: *309 + items: *313 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *310 + repository: *314 '403': *27 '404': *6 x-github: @@ -38957,7 +39933,7 @@ paths: type: integer codespaces: type: array - items: &356 + items: &360 type: object title: Codespace description: A codespace. @@ -38988,11 +39964,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *269 + repository: *273 machine: anyOf: - type: 'null' - - &556 + - &557 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -39279,7 +40255,7 @@ paths: - pulls_url - recent_folders examples: - default: &357 + default: &361 value: total_count: 3 codespaces: @@ -39903,7 +40879,7 @@ paths: type: integer secrets: type: array - items: &311 + items: &315 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -39944,7 +40920,7 @@ paths: - updated_at - visibility examples: - default: &557 + default: &558 value: total_count: 2 secrets: @@ -39982,7 +40958,7 @@ paths: description: Response content: application/json: - schema: &558 + schema: &559 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -40017,7 +40993,7 @@ paths: - key_id - key examples: - default: &559 + default: &560 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -40041,15 +41017,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - *81 - - *279 + - *283 responses: '200': description: Response content: application/json: - schema: *311 + schema: *315 examples: - default: &561 + default: &562 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -40077,7 +41053,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - *81 - - *279 + - *283 requestBody: required: true content: @@ -40132,7 +41108,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -40159,7 +41135,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - *81 - - *279 + - *283 responses: '204': description: Response @@ -40185,7 +41161,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - *81 - - *279 + - *283 - *19 - *17 responses: @@ -40203,9 +41179,9 @@ paths: type: integer repositories: type: array - items: *269 + items: *273 examples: - default: *283 + default: *287 '404': *6 x-github: githubCloudOnly: false @@ -40228,7 +41204,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - *81 - - *279 + - *283 requestBody: required: true content: @@ -40279,7 +41255,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - *81 - - *279 + - *283 - name: repository_id in: path required: true @@ -40313,7 +41289,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - *81 - - *279 + - *283 - name: repository_id in: path required: true @@ -40902,13 +41878,13 @@ paths: application/json: schema: type: array - items: *195 + items: *196 examples: - default: *196 + default: *197 '500': *38 '403': *27 '404': *6 - '422': *197 + '422': *198 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41136,7 +42112,7 @@ paths: - 3 custom_roles: type: array - items: *312 + items: *316 examples: default: value: @@ -41228,7 +42204,7 @@ paths: required: true content: application/json: - schema: &314 + schema: &318 type: object properties: name: @@ -41270,9 +42246,9 @@ paths: description: Response content: application/json: - schema: *312 + schema: *316 examples: - default: *313 + default: *317 '422': *15 '404': *6 x-github: @@ -41303,9 +42279,9 @@ paths: description: Response content: application/json: - schema: *312 + schema: *316 examples: - default: *313 + default: *317 '404': *6 x-github: githubCloudOnly: true @@ -41333,7 +42309,7 @@ paths: required: true content: application/json: - schema: &315 + schema: &319 type: object properties: name: @@ -41372,9 +42348,9 @@ paths: description: Response content: application/json: - schema: *312 + schema: *316 examples: - default: *313 + default: *317 '422': *15 '404': *6 x-github: @@ -41432,7 +42408,7 @@ paths: required: true content: application/json: - schema: *314 + schema: *318 examples: default: value: @@ -41446,9 +42422,9 @@ paths: description: Response content: application/json: - schema: *312 + schema: *316 examples: - default: *313 + default: *317 '422': *15 '404': *6 x-github: @@ -41485,9 +42461,9 @@ paths: description: Response content: application/json: - schema: *312 + schema: *316 examples: - default: *313 + default: *317 '404': *6 x-github: githubCloudOnly: true @@ -41521,7 +42497,7 @@ paths: required: true content: application/json: - schema: *315 + schema: *319 examples: default: value: @@ -41536,9 +42512,9 @@ paths: description: Response content: application/json: - schema: *312 + schema: *316 examples: - default: *313 + default: *317 '422': *15 '404': *6 x-github: @@ -41598,11 +42574,11 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *81 - - *316 - - *317 - - *318 - - *319 - *320 + - *321 + - *322 + - *323 + - *324 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -41640,8 +42616,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *321 - - *322 + - *325 + - *326 - *104 - *102 - *103 @@ -41653,9 +42629,9 @@ paths: application/json: schema: type: array - items: *323 + items: *327 examples: - default: *324 + default: *328 '304': *35 '400': *14 '403': *27 @@ -41699,7 +42675,7 @@ paths: type: integer secrets: type: array - items: &325 + items: &329 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -41778,7 +42754,7 @@ paths: description: Response content: application/json: - schema: &584 + schema: &585 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -41797,7 +42773,7 @@ paths: - key_id - key examples: - default: &585 + default: &586 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -41821,13 +42797,13 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - *81 - - *279 + - *283 responses: '200': description: Response content: application/json: - schema: *325 + schema: *329 examples: default: value: @@ -41856,7 +42832,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - *81 - - *279 + - *283 requestBody: required: true content: @@ -41915,7 +42891,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -41940,7 +42916,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - *81 - - *279 + - *283 responses: '204': description: Response @@ -41965,7 +42941,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - *81 - - *279 + - *283 - *19 - *17 responses: @@ -41983,9 +42959,9 @@ paths: type: integer repositories: type: array - items: *269 + items: *273 examples: - default: *283 + default: *287 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42007,7 +42983,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - *81 - - *279 + - *283 requestBody: required: true content: @@ -42058,7 +43034,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - *81 - - *279 + - *283 - name: repository_id in: path required: true @@ -42090,7 +43066,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - *81 - - *279 + - *283 - name: repository_id in: path required: true @@ -42127,7 +43103,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *81 - - &593 + - &594 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -42135,7 +43111,7 @@ paths: required: false schema: type: string - - &594 + - &595 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -42143,7 +43119,7 @@ paths: required: false schema: type: string - - &595 + - &596 name: time_period description: |- The time period to filter by. @@ -42159,7 +43135,7 @@ paths: - week - month default: month - - &596 + - &597 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -42174,7 +43150,7 @@ paths: - denied - all default: all - - *293 + - *297 - *17 - *19 responses: @@ -42184,7 +43160,7 @@ paths: application/json: schema: type: array - items: &597 + items: &598 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -42347,7 +43323,7 @@ paths: examples: - https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &598 + default: &599 value: - id: 21 number: 42 @@ -42434,11 +43410,11 @@ paths: subcategory: alert-dismissal-requests parameters: - *81 - - *293 + - *297 - *97 - *98 - *99 - - &599 + - &600 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -42464,7 +43440,7 @@ paths: application/json: schema: type: array - items: &600 + items: &601 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -42591,7 +43567,7 @@ paths: examples: - https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &601 + default: &602 value: - id: 21 number: 42 @@ -42679,7 +43655,7 @@ paths: application/json: schema: type: array - items: &366 + items: &370 title: Package description: A software package type: object @@ -42732,7 +43708,7 @@ paths: repository: anyOf: - type: 'null' - - *269 + - *273 created_at: type: string format: date-time @@ -42750,7 +43726,7 @@ paths: - created_at - updated_at examples: - default: &367 + default: &371 value: - id: 197 name: hello_docker @@ -42838,7 +43814,7 @@ paths: application/json: schema: type: array - items: *229 + items: *230 examples: 200-response: value: @@ -42937,7 +43913,7 @@ paths: description: Response content: application/json: - schema: &443 + schema: &446 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -43027,7 +44003,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &444 + default: &447 value: group_id: '123' group_name: Octocat admins @@ -43082,7 +44058,7 @@ paths: description: Response content: application/json: - schema: &441 + schema: &444 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -43122,7 +44098,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &442 + default: &445 value: groups: - group_id: '123' @@ -43166,7 +44142,7 @@ paths: application/json: schema: type: array - items: &348 + items: &352 title: Organization Invitation description: Organization Invitation type: object @@ -43220,7 +44196,7 @@ paths: - invitation_teams_url - node_id examples: - default: &349 + default: &353 value: - id: 1 login: monalisa @@ -43287,7 +44263,7 @@ paths: application/json: schema: type: array - items: &396 + items: &399 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -43301,7 +44277,7 @@ paths: - name - description examples: - default: &397 + default: &400 value: - name: add_assignee description: Assign or remove a user @@ -43342,7 +44318,7 @@ paths: application/json: schema: type: array - items: &326 + items: &330 title: Org Hook description: Org Hook type: object @@ -43525,9 +44501,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *330 examples: - default: &327 + default: &331 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -43572,7 +44548,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - *81 - - &328 + - &332 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. @@ -43585,9 +44561,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *330 examples: - default: *327 + default: *331 '404': *6 x-github: githubCloudOnly: false @@ -43609,7 +44585,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - *81 - - *328 + - *332 requestBody: required: false content: @@ -43655,7 +44631,7 @@ paths: description: Response content: application/json: - schema: *326 + schema: *330 examples: default: value: @@ -43695,7 +44671,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - *81 - - *328 + - *332 responses: '204': description: Response @@ -43721,7 +44697,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *81 - - *328 + - *332 responses: '200': description: Response @@ -43750,7 +44726,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *81 - - *328 + - *332 requestBody: required: false content: @@ -43799,9 +44775,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *81 - - *328 + - *332 - *17 - - *329 + - *333 responses: '200': description: Response @@ -43809,9 +44785,9 @@ paths: application/json: schema: type: array - items: *330 + items: *334 examples: - default: *331 + default: *335 '400': *14 '422': *15 x-github: @@ -43835,16 +44811,16 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *81 - - *328 + - *332 - *16 responses: '200': description: Response content: application/json: - schema: *332 + schema: *336 examples: - default: *333 + default: *337 '400': *14 '422': *15 x-github: @@ -43868,7 +44844,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *81 - - *328 + - *332 - *16 responses: '202': *37 @@ -43895,7 +44871,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - *81 - - *328 + - *332 responses: '204': description: Response @@ -43918,7 +44894,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - *81 - - &338 + - &342 name: actor_type in: path description: The type of the actor @@ -43931,14 +44907,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &339 + - &343 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &334 + - &338 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`.' @@ -43946,7 +44922,7 @@ paths: required: true schema: type: string - - &335 + - &339 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) @@ -44041,12 +45017,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - *81 - - *334 - - *335 + - *338 + - *339 - *19 - *17 - *104 - - &344 + - &348 name: sort description: The property to sort the results by. in: query @@ -44126,14 +45102,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - *81 - - *334 - - *335 + - *338 + - *339 responses: '200': description: Response content: application/json: - schema: &336 + schema: &340 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -44149,7 +45125,7 @@ paths: type: integer format: int64 examples: - default: &337 + default: &341 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -44170,23 +45146,23 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - *81 - - &340 + - &344 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *334 - - *335 + - *338 + - *339 responses: '200': description: Response content: application/json: - schema: *336 + schema: *340 examples: - default: *337 + default: *341 x-github: enabledForGitHubApps: true category: orgs @@ -44205,18 +45181,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *81 - - *334 - - *335 - *338 - *339 + - *342 + - *343 responses: '200': description: Response content: application/json: - schema: *336 + schema: *340 examples: - default: *337 + default: *341 x-github: enabledForGitHubApps: true category: orgs @@ -44234,9 +45210,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - *81 - - *334 - - *335 - - &341 + - *338 + - *339 + - &345 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -44249,7 +45225,7 @@ paths: description: Response content: application/json: - schema: &342 + schema: &346 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -44265,7 +45241,7 @@ paths: type: integer format: int64 examples: - default: &343 + default: &347 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -44302,18 +45278,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - *81 - - *340 - - *334 - - *335 - - *341 + - *344 + - *338 + - *339 + - *345 responses: '200': description: Response content: application/json: - schema: *342 + schema: *346 examples: - default: *343 + default: *347 x-github: enabledForGitHubApps: true category: orgs @@ -44331,19 +45307,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - *81 + - *342 + - *343 - *338 - *339 - - *334 - - *335 - - *341 + - *345 responses: '200': description: Response content: application/json: - schema: *342 + schema: *346 examples: - default: *343 + default: *347 x-github: enabledForGitHubApps: true category: orgs @@ -44361,13 +45337,13 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - *81 - - *340 - - *334 - - *335 + - *344 + - *338 + - *339 - *19 - *17 - *104 - - *344 + - *348 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -44451,7 +45427,7 @@ paths: application/json: schema: *20 examples: - default: &632 + default: &633 value: id: 1 account: @@ -44617,12 +45593,12 @@ paths: application/json: schema: anyOf: - - &346 + - &350 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &345 + limit: &349 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -44650,7 +45626,7 @@ paths: properties: {} additionalProperties: false examples: - default: &347 + default: &351 value: limit: collaborators_only origin: organization @@ -44679,13 +45655,13 @@ paths: required: true content: application/json: - schema: &633 + schema: &634 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *345 + limit: *349 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -44710,9 +45686,9 @@ paths: description: Response content: application/json: - schema: *346 + schema: *350 examples: - default: *347 + default: *351 '422': *15 x-github: githubCloudOnly: false @@ -44790,9 +45766,9 @@ paths: application/json: schema: type: array - items: *348 + items: *352 examples: - default: *349 + default: *353 headers: Link: *41 '404': *6 @@ -44870,7 +45846,7 @@ paths: description: Response content: application/json: - schema: *348 + schema: *352 examples: default: value: @@ -44927,7 +45903,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - *81 - - &350 + - &354 name: invitation_id description: The unique identifier of the invitation. in: path @@ -44961,7 +45937,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - *81 - - *350 + - *354 - *17 - *19 responses: @@ -44971,9 +45947,9 @@ paths: application/json: schema: type: array - items: *296 + items: *300 examples: - default: &365 + default: &369 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -45016,7 +45992,7 @@ paths: application/json: schema: type: array - items: *351 + items: *355 examples: default: value: @@ -45104,9 +46080,9 @@ paths: description: Response content: application/json: - schema: *351 + schema: *355 examples: - default: &352 + default: &356 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -45139,7 +46115,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *81 - - &353 + - &357 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -45195,9 +46171,9 @@ paths: description: Response content: application/json: - schema: *351 + schema: *355 examples: - default: *352 + default: *356 '404': *6 '422': *7 x-github: @@ -45222,7 +46198,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *81 - - *353 + - *357 responses: '204': description: Response @@ -45285,7 +46261,7 @@ paths: - closed - all default: open - - *354 + - *358 - name: type description: Can be the name of an issue type. in: query @@ -45304,7 +46280,7 @@ paths: - comments default: created - *104 - - *208 + - *209 - *17 - *19 responses: @@ -45314,9 +46290,9 @@ paths: application/json: schema: type: array - items: *218 + items: *219 examples: - default: *355 + default: *359 headers: Link: *41 '404': *6 @@ -45376,7 +46352,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 '422': *15 @@ -45475,9 +46451,9 @@ paths: type: integer codespaces: type: array - items: *356 + items: *360 examples: - default: *357 + default: *361 '304': *35 '500': *38 '401': *23 @@ -45504,7 +46480,7 @@ paths: parameters: - *81 - *132 - - &358 + - &362 name: codespace_name in: path required: true @@ -45539,15 +46515,15 @@ paths: parameters: - *81 - *132 - - *358 + - *362 responses: '200': description: Response content: application/json: - schema: *356 + schema: *360 examples: - default: &555 + default: &556 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -45803,7 +46779,7 @@ paths: description: Response content: application/json: - schema: &359 + schema: &363 title: Org Membership description: Org Membership type: object @@ -45872,7 +46848,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &360 + response-if-user-has-an-active-admin-membership-with-organization: &364 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -45969,9 +46945,9 @@ paths: description: Response content: application/json: - schema: *359 + schema: *363 examples: - response-if-user-already-had-membership-with-organization: *360 + response-if-user-already-had-membership-with-organization: *364 '422': *15 '403': *27 x-github: @@ -46043,7 +47019,7 @@ paths: application/json: schema: type: array - items: &361 + items: &365 title: Migration description: A migration. type: object @@ -46381,7 +47357,7 @@ paths: description: Response content: application/json: - schema: *361 + schema: *365 examples: default: value: @@ -46560,7 +47536,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - *81 - - &362 + - &366 name: migration_id description: The unique identifier of the migration. in: path @@ -46588,7 +47564,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *361 + schema: *365 examples: default: value: @@ -46758,7 +47734,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - *81 - - *362 + - *366 responses: '302': description: Response @@ -46780,7 +47756,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *81 - - *362 + - *366 responses: '204': description: Response @@ -46804,8 +47780,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - *81 - - *362 - - &802 + - *366 + - &804 name: repo_name description: repo_name parameter in: path @@ -46833,7 +47809,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *81 - - *362 + - *366 - *17 - *19 responses: @@ -46843,9 +47819,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: &372 + default: &376 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -47054,7 +48030,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &363 + items: &367 title: Organization Role description: Organization roles type: object @@ -47263,7 +48239,7 @@ paths: description: Response content: application/json: - schema: *363 + schema: *367 examples: default: value: @@ -47315,7 +48291,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - *81 - - *203 + - *204 responses: '204': description: Response @@ -47341,7 +48317,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - *81 - - *203 + - *204 - *131 responses: '204': @@ -47372,7 +48348,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - *81 - - *203 + - *204 - *131 responses: '204': @@ -47493,7 +48469,7 @@ paths: description: Response content: application/json: - schema: *363 + schema: *367 examples: default: value: @@ -47590,7 +48566,7 @@ paths: description: Response content: application/json: - schema: *363 + schema: *367 examples: default: value: @@ -47749,7 +48725,7 @@ paths: parent: anyOf: - type: 'null' - - *364 + - *368 type: description: The ownership type of the team type: string @@ -47782,7 +48758,7 @@ paths: - type - parent examples: - default: *365 + default: *369 headers: Link: *41 '404': @@ -47841,7 +48817,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *364 + items: *368 name: type: - string @@ -47958,7 +48934,7 @@ paths: - type - url examples: - default: *200 + default: *201 headers: Link: *41 '404': @@ -48009,7 +48985,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 x-github: @@ -48151,7 +49127,7 @@ paths: - nuget - container - *81 - - &803 + - &805 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -48187,12 +49163,12 @@ paths: application/json: schema: type: array - items: *366 + items: *370 examples: - default: *367 + default: *371 '403': *27 '401': *23 - '400': &805 + '400': &807 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -48214,7 +49190,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &368 + - &372 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 @@ -48232,7 +49208,7 @@ paths: - docker - nuget - container - - &369 + - &373 name: package_name description: The name of the package. in: path @@ -48245,7 +49221,7 @@ paths: description: Response content: application/json: - schema: *366 + schema: *370 examples: default: value: @@ -48297,8 +49273,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *368 - - *369 + - *372 + - *373 - *81 responses: '204': @@ -48331,8 +49307,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *368 - - *369 + - *372 + - *373 - *81 - name: token description: package token @@ -48365,8 +49341,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-an-organization parameters: - - *368 - - *369 + - *372 + - *373 - *81 - *19 - *17 @@ -48387,7 +49363,7 @@ paths: application/json: schema: type: array - items: &370 + items: &374 title: Package Version description: A version of a software package type: object @@ -48522,10 +49498,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: - - *368 - - *369 + - *372 + - *373 - *81 - - &371 + - &375 name: package_version_id description: Unique identifier of the package version. in: path @@ -48537,7 +49513,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *374 examples: default: value: @@ -48573,10 +49549,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *368 - - *369 + - *372 + - *373 - *81 - - *371 + - *375 responses: '204': description: Response @@ -48608,10 +49584,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *368 - - *369 + - *372 + - *373 - *81 - - *371 + - *375 responses: '204': description: Response @@ -48641,7 +49617,7 @@ paths: - *81 - *17 - *19 - - &373 + - &377 name: sort description: The property by which to sort the results. in: query @@ -48652,7 +49628,7 @@ paths: - created_at default: created_at - *104 - - &374 + - &378 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -48664,7 +49640,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &375 + - &379 name: repository description: The name of the repository to use to filter the results. in: query @@ -48673,7 +49649,7 @@ paths: type: string examples: - Hello-World - - &376 + - &380 name: permission description: The permission to use to filter the results. in: query @@ -48682,7 +49658,7 @@ paths: type: string examples: - issues_read - - &377 + - &381 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) @@ -48692,7 +49668,7 @@ paths: schema: type: string format: date-time - - &378 + - &382 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) @@ -48702,7 +49678,7 @@ paths: schema: type: string format: date-time - - &379 + - &383 name: token_id description: The ID of the token in: query @@ -49019,9 +49995,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: *372 + default: *376 headers: Link: *41 x-github: @@ -49047,14 +50023,14 @@ paths: - *81 - *17 - *19 - - *373 - - *104 - - *374 - - *375 - - *376 - *377 + - *104 - *378 - *379 + - *380 + - *381 + - *382 + - *383 responses: '500': *38 '422': *15 @@ -49336,9 +50312,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: *372 + default: *376 headers: Link: *41 x-github: @@ -49380,7 +50356,7 @@ paths: type: integer configurations: type: array - items: &380 + items: &384 title: Organization private registry description: Private registry configuration for an organization type: object @@ -49676,7 +50652,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &381 + org-private-registry-with-selected-visibility: &385 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -49768,15 +50744,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - *81 - - *279 + - *283 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *380 + schema: *384 examples: - default: *381 + default: *385 '404': *6 x-github: githubCloudOnly: false @@ -49798,7 +50774,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - *81 - - *279 + - *283 requestBody: required: true content: @@ -49904,7 +50880,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - *81 - - *279 + - *283 responses: '204': description: Response @@ -49915,275 +50891,6 @@ paths: enabledForGitHubApps: true category: private-registries subcategory: organization-configurations - "/orgs/{org}/projects": - get: - summary: List organization 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: - - projects-classic - operationId: projects-classic/list-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-organization-projects - parameters: - - *81 - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &382 - title: Project - description: Projects are a way to organize columns and cards of - work. - type: object - properties: - owner_url: - type: string - format: uri - examples: - - https://api.github.com/repos/api-playground/projects-test - url: - type: string - format: uri - examples: - - https://api.github.com/projects/1002604 - html_url: - type: string - format: uri - examples: - - https://github.com/api-playground/projects-test/projects/12 - columns_url: - type: string - format: uri - examples: - - https://api.github.com/projects/1002604/columns - id: - type: integer - examples: - - 1002604 - node_id: - type: string - examples: - - MDc6UHJvamVjdDEwMDI2MDQ= - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - number: - type: integer - examples: - - 1 - state: - description: State of the project; either 'open' or 'closed' - type: string - examples: - - open - creator: - anyOf: - - type: 'null' - - *4 - created_at: - type: string - format: date-time - examples: - - '2011-04-10T20:09:31Z' - updated_at: - type: string - format: date-time - examples: - - '2014-03-03T18:58:10Z' - organization_permission: - description: The baseline permission that all organization members - have on this project. Only present if owner is an organization. - type: string - enum: - - read - - write - - admin - - none - private: - description: Whether or not this project can be seen by everyone. - Only present if owner is an organization. - type: boolean - required: - - id - - node_id - - number - - name - - body - - state - - url - - html_url - - owner_url - - creator - - columns_url - - created_at - - updated_at - 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: true - headers: - Link: *41 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create an organization 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: - - projects-classic - operationId: projects-classic/create-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-an-organization-project - parameters: - - *81 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the project. - body: - type: string - description: The description of the project. - required: - - name - examples: - default: - value: - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - responses: - '201': - description: Response - content: - application/json: - schema: *382 - 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' - '401': *23 - '403': *27 - '404': *6 - '410': &459 - description: Gone - content: - application/json: - schema: *3 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/orgs/{org}/projectsV2": get: summary: List projects for organization @@ -50213,7 +50920,7 @@ paths: application/json: schema: type: array - items: &383 + items: &386 title: Projects v2 Project description: A projects v2 project type: object @@ -50287,7 +50994,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &880 + - &882 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -50372,7 +51079,7 @@ paths: - deleted_at - deleted_by examples: - default: &384 + default: &387 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -50475,7 +51182,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-organization parameters: - - &385 + - &388 name: project_number description: The project's number. in: path @@ -50488,9 +51195,9 @@ paths: description: Response content: application/json: - schema: *383 + schema: *386 examples: - default: *384 + default: *387 headers: Link: *41 '304': *35 @@ -50512,7 +51219,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-organization parameters: - - *385 + - *388 - *81 - *17 - *102 @@ -50524,7 +51231,7 @@ paths: application/json: schema: type: array - items: &386 + items: &389 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -50674,7 +51381,7 @@ paths: - updated_at - project_url examples: - default: &822 + default: &824 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -50777,8 +51484,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - - *385 - - &823 + - *388 + - &825 name: field_id description: The unique identifier of the field. in: path @@ -50791,9 +51498,9 @@ paths: description: Response content: application/json: - schema: *386 + schema: *389 examples: - default: &824 + default: &826 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -50837,7 +51544,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *385 + - *388 - *81 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) @@ -50870,7 +51577,7 @@ paths: application/json: schema: type: array - items: &391 + items: &394 title: Projects v2 Item description: An item belonging to a project type: object @@ -50887,7 +51594,7 @@ paths: description: The API URL of the project that contains this item. examples: - https://api.github.com/users/monalisa/2/projectsV2/3 - content_type: &389 + content_type: &392 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -50944,7 +51651,7 @@ paths: - updated_at - archived_at examples: - default: &392 + default: &395 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -51639,7 +52346,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-organization-owned-project parameters: - *81 - - *385 + - *388 requestBody: required: true description: Details of the item to add to the project. @@ -51676,7 +52383,7 @@ paths: description: Response content: application/json: - schema: &825 + schema: &827 title: Projects v2 Item description: An item belonging to a project type: object @@ -51689,8 +52396,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *218 - - &568 + - *219 + - &569 title: Pull Request Simple description: Pull Request Simple type: object @@ -51810,7 +52517,7 @@ paths: milestone: anyOf: - type: 'null' - - *387 + - *390 active_lock_reason: type: - string @@ -51865,7 +52572,7 @@ paths: type: - array - 'null' - items: *296 + items: *300 head: type: object properties: @@ -51909,7 +52616,7 @@ paths: _links: type: object properties: - comments: &388 + comments: &391 title: Link description: Hypermedia Link type: object @@ -51918,13 +52625,13 @@ paths: type: string required: - href - commits: *388 - statuses: *388 - html: *388 - issue: *388 - review_comments: *388 - review_comment: *388 - self: *388 + commits: *391 + statuses: *391 + html: *391 + issue: *391 + review_comments: *391 + review_comment: *391 + self: *391 required: - comments - commits @@ -51934,8 +52641,8 @@ paths: - review_comments - review_comment - self - author_association: *205 - auto_merge: &677 + author_association: *206 + auto_merge: &679 title: Auto merge description: The status of auto merging a pull request. type: @@ -52037,7 +52744,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: *389 + content_type: *392 creator: *4 created_at: type: string @@ -52074,7 +52781,7 @@ paths: - updated_at - archived_at examples: - issue: &390 + issue: &393 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -52129,7 +52836,7 @@ paths: archived_at: project_url: https://api.github.com/users/octocat/projectsV2/1 item_url: https://api.github.com/users/octocat/projectsV2/items/17 - pull_request: *390 + pull_request: *393 '304': *35 '403': *27 '401': *23 @@ -52149,9 +52856,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: - - *385 + - *388 - *81 - - &393 + - &396 name: item_id description: The unique identifier of the project item. in: path @@ -52177,9 +52884,9 @@ paths: description: Response content: application/json: - schema: *391 + schema: *394 examples: - default: *392 + default: *395 headers: Link: *41 '304': *35 @@ -52200,9 +52907,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-organization parameters: - - *385 + - *388 - *81 - - *393 + - *396 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -52275,13 +52982,13 @@ paths: description: Response content: application/json: - schema: *391 + schema: *394 examples: - text_field: *392 - number_field: *392 - date_field: *392 - single_select_field: *392 - iteration_field: *392 + text_field: *395 + number_field: *395 + date_field: *395 + single_select_field: *395 + iteration_field: *395 '401': *23 '403': *27 '404': *6 @@ -52301,9 +53008,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-organization parameters: - - *385 + - *388 - *81 - - *393 + - *396 responses: '204': description: Response @@ -52466,7 +53173,7 @@ paths: required: true content: application/json: - schema: *394 + schema: *397 examples: default: value: @@ -52694,7 +53401,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 x-github: @@ -52832,9 +53539,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: *372 + default: *376 headers: Link: *41 x-github: @@ -53038,7 +53745,7 @@ paths: description: Response content: application/json: - schema: &461 + schema: &462 title: Full Repository description: Full Repository type: object @@ -53484,7 +54191,7 @@ paths: license: anyOf: - type: 'null' - - *219 + - *220 organization: anyOf: - type: 'null' @@ -53503,7 +54210,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &573 + code_of_conduct: &574 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -53533,7 +54240,7 @@ paths: - key - name - html_url - security_and_analysis: *395 + security_and_analysis: *398 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -53617,7 +54324,7 @@ paths: - network_count - subscribers_count examples: - default: &463 + default: &464 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -54143,9 +54850,9 @@ paths: application/json: schema: type: array - items: *396 + items: *399 examples: - default: *397 + default: *400 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -54170,7 +54877,7 @@ paths: - *81 - *17 - *19 - - &700 + - &702 name: targets description: | A comma-separated list of rule targets to filter by. @@ -54262,11 +54969,11 @@ paths: type: array description: The actors that can bypass the rules in this ruleset items: *158 - conditions: *398 + conditions: *401 rules: type: array description: An array of rules within the ruleset. - items: &400 + items: &403 title: Repository Rule type: object description: A repository rule. @@ -54330,7 +55037,7 @@ paths: application/json: schema: *179 examples: - default: &399 + default: &402 value: id: 21 name: super cool ruleset @@ -54385,7 +55092,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - *81 - - &702 + - &704 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 @@ -54395,16 +55102,16 @@ paths: schema: type: string x-multi-segment: true - - *293 + - *297 - *99 - - &703 + - &705 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 - - &704 + - &706 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -54424,7 +55131,7 @@ paths: description: Response content: application/json: - schema: &705 + schema: &707 title: Rule Suites description: Response type: array @@ -54480,7 +55187,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &706 + default: &708 value: - id: 21 actor_id: 12 @@ -54524,7 +55231,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *81 - - &707 + - &709 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -54540,7 +55247,7 @@ paths: description: Response content: application/json: - schema: &708 + schema: &710 title: Rule Suite description: Response type: object @@ -54647,7 +55354,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &709 + default: &711 value: id: 21 actor_id: 12 @@ -54722,7 +55429,7 @@ paths: application/json: schema: *179 examples: - default: *399 + default: *402 '404': *6 '500': *38 put: @@ -54771,11 +55478,11 @@ paths: type: array description: The actors that can bypass the rules in this ruleset items: *158 - conditions: *398 + conditions: *401 rules: description: An array of rules within the ruleset. type: array - items: *400 + items: *403 examples: default: value: @@ -54812,7 +55519,7 @@ paths: application/json: schema: *179 examples: - default: *399 + default: *402 '404': *6 '500': *38 delete: @@ -54871,7 +55578,7 @@ paths: type: array items: *183 examples: - default: *401 + default: *404 '404': *6 '500': *38 x-github: @@ -54908,7 +55615,7 @@ paths: description: Response content: application/json: - schema: *402 + schema: *405 examples: default: value: @@ -54971,14 +55678,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *81 - - *403 - - *404 - - *405 - *406 + - *407 + - *408 + - *409 - *104 - *19 - *17 - - &711 + - &713 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 @@ -54988,7 +55695,7 @@ paths: required: false schema: type: string - - &712 + - &714 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 @@ -54998,10 +55705,10 @@ paths: required: false schema: type: string - - *407 - - *408 - - *409 - *410 + - *411 + - *412 + - *413 responses: '200': description: Response @@ -55009,9 +55716,9 @@ paths: application/json: schema: type: array - items: *411 + items: *414 examples: - default: *412 + default: *415 headers: Link: *41 '404': *6 @@ -55046,9 +55753,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *416 examples: - default: *414 + default: *417 '403': *27 '404': *6 patch: @@ -55201,7 +55908,7 @@ paths: application/json: schema: type: array - items: &733 + items: &735 description: A repository security advisory. type: object properties: @@ -55445,7 +56152,7 @@ paths: login: type: string description: The username of the user credited. - type: *415 + type: *418 credits_detailed: type: - array @@ -55456,7 +56163,7 @@ paths: type: object properties: user: *4 - type: *415 + type: *418 state: type: string description: The state of the user's acceptance of the @@ -55482,7 +56189,7 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *296 + items: *300 private_fork: readOnly: true description: A temporary private fork of the advisory's repository @@ -55520,7 +56227,7 @@ paths: - private_fork additionalProperties: false examples: - default: &734 + default: &736 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -55907,9 +56614,9 @@ paths: application/json: schema: type: array - items: *364 + items: *368 examples: - default: *365 + default: *369 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55933,7 +56640,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - *81 - - *203 + - *204 responses: '204': description: Response @@ -55959,7 +56666,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - *81 - - *203 + - *204 responses: '204': description: Response @@ -55994,9 +56701,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *419 examples: - default: *417 + default: *420 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56021,7 +56728,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *81 - - *418 + - *421 - *17 - *19 responses: @@ -56029,9 +56736,9 @@ paths: description: Success content: application/json: - schema: *419 + schema: *422 examples: - default: *420 + default: *423 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -56059,9 +56766,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *424 examples: - default: *422 + default: *425 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56089,9 +56796,9 @@ paths: description: Response content: application/json: - schema: *423 + schema: *426 examples: - default: *424 + default: *427 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56237,9 +56944,9 @@ paths: type: integer repositories: type: array - items: *269 + items: *273 examples: - default: *283 + default: *287 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56308,7 +57015,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *81 - - *263 + - *267 responses: '204': description: Response @@ -56331,7 +57038,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *81 - - *263 + - *267 responses: '204': description: Response @@ -56374,7 +57081,7 @@ paths: type: array items: *137 examples: - default: *425 + default: *428 headers: Link: *41 x-github: @@ -56575,15 +57282,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - *81 - - *426 + - *429 responses: '200': description: Response content: application/json: - schema: *427 + schema: *430 examples: - default: *428 + default: *431 headers: Link: *41 x-github: @@ -56621,7 +57328,7 @@ paths: description: Response content: application/json: - schema: &450 + schema: &453 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -56673,7 +57380,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &451 + default: &454 value: groups: - group_id: '123' @@ -56719,7 +57426,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - *81 - - *203 + - *204 - 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`). @@ -56751,13 +57458,13 @@ paths: application/json: schema: type: array - items: *195 + items: *196 examples: - default: *196 + default: *197 '500': *38 '403': *27 '404': *6 - '422': *197 + '422': *198 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56785,9 +57492,9 @@ paths: application/json: schema: type: array - items: *296 + items: *300 examples: - default: *365 + default: *369 headers: Link: *41 '403': *27 @@ -56881,7 +57588,7 @@ paths: description: Response content: application/json: - schema: &429 + schema: &432 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -56955,7 +57662,7 @@ paths: parent: anyOf: - type: 'null' - - *364 + - *368 members_count: type: integer examples: @@ -57280,7 +57987,7 @@ paths: - repos_count - organization examples: - default: &430 + default: &433 value: id: 1 node_id: MDQ6VGVhbTE= @@ -57351,15 +58058,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - *81 - - *203 + - *204 responses: '200': description: Response content: application/json: - schema: *429 + schema: *432 examples: - default: *430 + default: *433 '404': *6 x-github: githubCloudOnly: false @@ -57381,7 +58088,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - *81 - - *203 + - *204 requestBody: required: false content: @@ -57444,16 +58151,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *429 + schema: *432 examples: - default: *430 + default: *433 '201': description: Response content: application/json: - schema: *429 + schema: *432 examples: - default: *430 + default: *433 '404': *6 '422': *15 '403': *27 @@ -57479,7 +58186,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - *81 - - *203 + - *204 responses: '204': description: Response @@ -57506,7 +58213,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - *81 - - *203 + - *204 - *104 - *17 - *19 @@ -57523,7 +58230,7 @@ paths: application/json: schema: type: array - items: &431 + items: &434 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -57614,7 +58321,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *206 + reactions: *207 required: - author - body @@ -57634,7 +58341,7 @@ paths: - updated_at - url examples: - default: &777 + default: &779 value: - author: login: octocat @@ -57709,7 +58416,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - *81 - - *203 + - *204 requestBody: required: true content: @@ -57743,9 +58450,9 @@ paths: description: Response content: application/json: - schema: *431 + schema: *434 examples: - default: &432 + default: &435 value: author: login: octocat @@ -57818,8 +58525,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - *81 - - *203 - - &433 + - *204 + - &436 name: discussion_number description: The number that identifies the discussion. in: path @@ -57831,9 +58538,9 @@ paths: description: Response content: application/json: - schema: *431 + schema: *434 examples: - default: *432 + default: *435 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57856,8 +58563,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - *81 - - *203 - - *433 + - *204 + - *436 requestBody: required: false content: @@ -57880,9 +58587,9 @@ paths: description: Response content: application/json: - schema: *431 + schema: *434 examples: - default: &778 + default: &780 value: author: login: octocat @@ -57953,8 +58660,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - *81 - - *203 - - *433 + - *204 + - *436 responses: '204': description: Response @@ -57981,8 +58688,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - *81 - - *203 - - *433 + - *204 + - *436 - *104 - *17 - *19 @@ -57993,7 +58700,7 @@ paths: application/json: schema: type: array - items: &434 + items: &437 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -58058,7 +58765,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *206 + reactions: *207 required: - author - body @@ -58073,7 +58780,7 @@ paths: - updated_at - url examples: - default: &779 + default: &781 value: - author: login: octocat @@ -58142,8 +58849,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - *81 - - *203 - - *433 + - *204 + - *436 requestBody: required: true content: @@ -58165,9 +58872,9 @@ paths: description: Response content: application/json: - schema: *434 + schema: *437 examples: - default: &435 + default: &438 value: author: login: octocat @@ -58234,9 +58941,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - *81 - - *203 - - *433 - - &436 + - *204 + - *436 + - &439 name: comment_number description: The number that identifies the comment. in: path @@ -58248,9 +58955,9 @@ paths: description: Response content: application/json: - schema: *434 + schema: *437 examples: - default: *435 + default: *438 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58273,9 +58980,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - *81 - - *203 - - *433 + - *204 - *436 + - *439 requestBody: required: true content: @@ -58297,9 +59004,9 @@ paths: description: Response content: application/json: - schema: *434 + schema: *437 examples: - default: &780 + default: &782 value: author: login: octocat @@ -58364,9 +59071,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - *81 - - *203 - - *433 + - *204 - *436 + - *439 responses: '204': description: Response @@ -58393,9 +59100,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - *81 - - *203 - - *433 + - *204 - *436 + - *439 - 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. @@ -58421,7 +59128,7 @@ paths: application/json: schema: type: array - items: &437 + items: &440 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -58465,7 +59172,7 @@ paths: - content - created_at examples: - default: &439 + default: &442 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -58516,9 +59223,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - *81 - - *203 - - *433 + - *204 - *436 + - *439 requestBody: required: true content: @@ -58551,9 +59258,9 @@ paths: team discussion comment content: application/json: - schema: *437 + schema: *440 examples: - default: &438 + default: &441 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -58582,9 +59289,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58608,10 +59315,10 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - *81 - - *203 - - *433 + - *204 - *436 - - &440 + - *439 + - &443 name: reaction_id description: The unique identifier of the reaction. in: path @@ -58644,8 +59351,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - *81 - - *203 - - *433 + - *204 + - *436 - 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. @@ -58671,9 +59378,9 @@ paths: application/json: schema: type: array - items: *437 + items: *440 examples: - default: *439 + default: *442 headers: Link: *41 x-github: @@ -58700,8 +59407,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - *81 - - *203 - - *433 + - *204 + - *436 requestBody: required: true content: @@ -58733,16 +59440,16 @@ paths: description: Response content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '201': description: Response content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -58766,9 +59473,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - *81 - - *203 - - *433 - - *440 + - *204 + - *436 + - *443 responses: '204': description: Response @@ -58792,15 +59499,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team parameters: - *81 - - *203 + - *204 responses: '200': description: Response content: application/json: - schema: *441 + schema: *444 examples: - default: *442 + default: *445 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -58820,7 +59527,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team parameters: - *81 - - *203 + - *204 requestBody: required: true content: @@ -58844,9 +59551,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *446 examples: - default: *444 + default: *447 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -58866,7 +59573,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team parameters: - *81 - - *203 + - *204 responses: '204': description: Response @@ -58891,7 +59598,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - *81 - - *203 + - *204 - *17 - *19 responses: @@ -58901,9 +59608,9 @@ paths: application/json: schema: type: array - items: *348 + items: *352 examples: - default: *349 + default: *353 headers: Link: *41 x-github: @@ -58926,7 +59633,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - *81 - - *203 + - *204 - name: role description: Filters members returned by their role in the team. in: query @@ -58949,7 +59656,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 x-github: @@ -58980,14 +59687,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - *81 - - *203 + - *204 - *132 responses: '200': description: Response content: application/json: - schema: &445 + schema: &448 title: Team Membership description: Team Membership type: object @@ -59015,7 +59722,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &781 + response-if-user-is-a-team-maintainer: &783 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -59052,7 +59759,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user parameters: - *81 - - *203 + - *204 - *132 requestBody: required: false @@ -59078,9 +59785,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *448 examples: - response-if-users-membership-with-team-is-now-pending: &782 + response-if-users-membership-with-team-is-now-pending: &784 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -59116,7 +59823,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - *81 - - *203 + - *204 - *132 responses: '204': @@ -59143,7 +59850,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - *81 - - *203 + - *204 - *17 - *19 responses: @@ -59153,7 +59860,7 @@ paths: application/json: schema: type: array - items: &446 + items: &449 title: Team Project description: A team's access to a project. type: object @@ -59222,7 +59929,7 @@ paths: - updated_at - permissions examples: - default: &783 + default: &785 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -59286,8 +59993,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - *81 - - *203 - - &447 + - *204 + - &450 name: project_id description: The unique identifier of the project. in: path @@ -59299,9 +60006,9 @@ paths: description: Response content: application/json: - schema: *446 + schema: *449 examples: - default: &784 + default: &786 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -59364,8 +60071,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - *81 - - *203 - - *447 + - *204 + - *450 requestBody: required: false content: @@ -59433,8 +60140,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - *81 - - *203 - - *447 + - *204 + - *450 responses: '204': description: Response @@ -59462,7 +60169,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - *81 - - *203 + - *204 - *17 - *19 responses: @@ -59472,9 +60179,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: *372 + default: *376 headers: Link: *41 x-github: @@ -59504,15 +60211,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - *81 - - *203 - - *448 - - *449 + - *204 + - *451 + - *452 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &785 + schema: &787 title: Team Repository description: A team's access to a repository. type: object @@ -59538,7 +60245,7 @@ paths: license: anyOf: - type: 'null' - - *219 + - *220 forks: type: integer permissions: @@ -60154,9 +60861,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - *81 - - *203 - - *448 - - *449 + - *204 + - *451 + - *452 requestBody: required: false content: @@ -60202,9 +60909,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - *81 - - *203 - - *448 - - *449 + - *204 + - *451 + - *452 responses: '204': description: Response @@ -60231,15 +60938,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team parameters: - *81 - - *203 + - *204 responses: '200': description: Response content: application/json: - schema: *450 + schema: *453 examples: - default: *451 + default: *454 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -60262,7 +60969,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections parameters: - *81 - - *203 + - *204 requestBody: required: true content: @@ -60305,7 +61012,7 @@ paths: description: Response content: application/json: - schema: *450 + schema: *453 examples: default: value: @@ -60338,7 +61045,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - *81 - - *203 + - *204 - *17 - *19 responses: @@ -60348,9 +61055,9 @@ paths: application/json: schema: type: array - items: *296 + items: *300 examples: - response-if-child-teams-exist: &786 + response-if-child-teams-exist: &788 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -60477,7 +61184,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card parameters: - - &452 + - &455 name: card_id description: The unique identifier of the card. in: path @@ -60489,7 +61196,7 @@ paths: description: Response content: application/json: - schema: &453 + schema: &456 title: Project Card description: Project cards represent a scope of work. type: object @@ -60564,7 +61271,7 @@ paths: - created_at - updated_at examples: - default: &454 + default: &457 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -60620,7 +61327,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card parameters: - - *452 + - *455 requestBody: required: false content: @@ -60650,9 +61357,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *456 examples: - default: *454 + default: *457 '304': *35 '403': *27 '401': *23 @@ -60679,7 +61386,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card parameters: - - *452 + - *455 responses: '204': description: Response @@ -60723,7 +61430,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card parameters: - - *452 + - *455 requestBody: required: true content: @@ -60836,7 +61543,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column parameters: - - &455 + - &458 name: column_id description: The unique identifier of the column. in: path @@ -60848,7 +61555,7 @@ paths: description: Response content: application/json: - schema: &456 + schema: &459 title: Project Column description: Project columns contain cards of work. type: object @@ -60902,7 +61609,7 @@ paths: - created_at - updated_at examples: - default: &457 + default: &460 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -60937,7 +61644,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column parameters: - - *455 + - *458 requestBody: required: true content: @@ -60962,9 +61669,9 @@ paths: description: Response content: application/json: - schema: *456 + schema: *459 examples: - default: *457 + default: *460 '304': *35 '403': *27 '401': *23 @@ -60989,7 +61696,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column parameters: - - *455 + - *458 responses: '204': description: Response @@ -61018,7 +61725,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards parameters: - - *455 + - *458 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -61039,7 +61746,7 @@ paths: application/json: schema: type: array - items: *453 + items: *456 examples: default: value: @@ -61098,7 +61805,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card parameters: - - *455 + - *458 requestBody: required: true content: @@ -61142,9 +61849,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *456 examples: - default: *454 + default: *457 '304': *35 '403': *27 '401': *23 @@ -61154,8 +61861,8 @@ paths: application/json: schema: oneOf: - - *244 - - *245 + - *248 + - *249 '503': description: Response content: @@ -61200,7 +61907,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column parameters: - - *455 + - *458 requestBody: required: true content: @@ -61247,211 +61954,6 @@ paths: deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true - "/projects/{project_id}": - get: - summary: Get 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: - - projects-classic - operationId: projects-classic/get - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#get-a-project - parameters: - - *447 - responses: - '200': - description: Response - content: - application/json: - schema: *382 - examples: - default: &458 - value: - owner_url: https://api.github.com/repos/api-playground/projects-test - url: https://api.github.com/projects/1002604 - html_url: https://github.com/api-playground/projects-test/projects/1 - columns_url: https://api.github.com/projects/1002604/columns - id: 1002604 - node_id: MDc6UHJvamVjdDEwMDI2MDQ= - name: Projects Documentation - body: Developer documentation project for the developer site. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - '304': *35 - '403': *27 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update 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. - operationId: projects-classic/update - tags: - - projects-classic - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#update-a-project - parameters: - - *447 - requestBody: - required: false - content: - application/json: - schema: - properties: - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - state: - description: State of the project; either 'open' or 'closed' - type: string - examples: - - open - organization_permission: - description: The baseline permission that all organization members - have on this project - type: string - enum: - - read - - write - - admin - - none - private: - description: Whether or not this project can be seen by everyone. - type: boolean - type: object - examples: - default: - summary: Change the name, state, and permissions for a project - value: - name: Week One Sprint - state: open - organization_permission: write - responses: - '200': - description: Response - content: - application/json: - schema: *382 - examples: - default: *458 - '404': - description: Not Found if the authenticated user does not have access to - the project - '304': *35 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *23 - '410': *459 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete 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. - operationId: projects-classic/delete - tags: - - projects-classic - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#delete-a-project - parameters: - - *447 - responses: - '204': - description: Delete Success - '304': *35 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *23 - '410': *459 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/projects/{project_id}/collaborators": get: summary: List project collaborators @@ -61466,7 +61968,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators parameters: - - *447 + - *450 - 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 @@ -61493,7 +61995,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 '404': *6 @@ -61523,7 +62025,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator parameters: - - *447 + - *450 - *132 requestBody: required: false @@ -61578,7 +62080,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *447 + - *450 - *132 responses: '204': @@ -61610,7 +62112,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#get-project-permission-for-a-user parameters: - - *447 + - *450 - *132 responses: '200': @@ -61708,7 +62210,7 @@ paths: resources: type: object properties: - core: &460 + core: &461 title: Rate Limit type: object properties: @@ -61725,21 +62227,21 @@ paths: - remaining - reset - used - graphql: *460 - search: *460 - code_search: *460 - source_import: *460 - integration_manifest: *460 - code_scanning_upload: *460 - actions_runner_registration: *460 - scim: *460 - dependency_snapshots: *460 - dependency_sbom: *460 - code_scanning_autofix: *460 + graphql: *461 + search: *461 + code_search: *461 + source_import: *461 + integration_manifest: *461 + code_scanning_upload: *461 + actions_runner_registration: *461 + scim: *461 + dependency_snapshots: *461 + dependency_sbom: *461 + code_scanning_autofix: *461 required: - core - search - rate: *460 + rate: *461 required: - rate - resources @@ -61844,14 +62346,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *461 + schema: *462 examples: default-response: summary: Default response @@ -62356,7 +62858,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *462 + '301': *463 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62374,8 +62876,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: false content: @@ -62633,10 +63135,10 @@ paths: description: Response content: application/json: - schema: *461 + schema: *462 examples: - default: *463 - '307': &464 + default: *464 + '307': &465 description: Temporary Redirect content: application/json: @@ -62665,8 +63167,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -62688,7 +63190,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository - '307': *464 + '307': *465 '404': *6 '409': *112 x-github: @@ -62712,11 +63214,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 - - &479 + - &480 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -62739,7 +63241,7 @@ paths: type: integer artifacts: type: array - items: &465 + items: &466 title: Artifact description: An artifact type: object @@ -62834,7 +63336,7 @@ paths: - expires_at - updated_at examples: - default: &480 + default: &481 value: total_count: 2 artifacts: @@ -62895,9 +63397,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *448 - - *449 - - &466 + - *451 + - *452 + - &467 name: artifact_id description: The unique identifier of the artifact. in: path @@ -62909,7 +63411,7 @@ paths: description: Response content: application/json: - schema: *465 + schema: *466 examples: default: value: @@ -62947,9 +63449,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *448 - - *449 - - *466 + - *451 + - *452 + - *467 responses: '204': description: Response @@ -62973,9 +63475,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *448 - - *449 - - *466 + - *451 + - *452 + - *467 - name: archive_format in: path required: true @@ -62989,7 +63491,11 @@ 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': *459 + '410': &637 + description: Gone + content: + application/json: + schema: *3 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63012,14 +63518,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *467 + schema: *468 examples: default: value: @@ -63045,11 +63551,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: - - *448 - - *449 + - *451 + - *452 - *17 - *19 - - &468 + - &469 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 @@ -63083,7 +63589,7 @@ paths: description: Response content: application/json: - schema: &469 + schema: &470 title: Repository actions caches description: Repository actions caches type: object @@ -63133,7 +63639,7 @@ paths: - total_count - actions_caches examples: - default: &470 + default: &471 value: total_count: 1 actions_caches: @@ -63165,23 +63671,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: - - *448 - - *449 + - *451 + - *452 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *468 + - *469 responses: '200': description: Response content: application/json: - schema: *469 + schema: *470 examples: - default: *470 + default: *471 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63201,8 +63707,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: - - *448 - - *449 + - *451 + - *452 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -63233,9 +63739,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: - - *448 - - *449 - - &471 + - *451 + - *452 + - &472 name: job_id description: The unique identifier of the job. in: path @@ -63247,7 +63753,7 @@ paths: description: Response content: application/json: - schema: &483 + schema: &484 title: Job description: Information of a job execution in a workflow run type: object @@ -63594,9 +64100,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: - - *448 - - *449 - - *471 + - *451 + - *452 + - *472 responses: '302': description: Response @@ -63624,9 +64130,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: - - *448 - - *449 - - *471 + - *451 + - *452 + - *472 requestBody: required: false content: @@ -63648,7 +64154,7 @@ paths: description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -63672,8 +64178,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Status response @@ -63723,8 +64229,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -63758,7 +64264,7 @@ paths: description: Empty response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -63787,8 +64293,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -63806,7 +64312,7 @@ paths: type: integer secrets: type: array - items: &485 + items: &486 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -63827,7 +64333,7 @@ paths: - created_at - updated_at examples: - default: &486 + default: &487 value: total_count: 2 secrets: @@ -63860,9 +64366,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *448 - - *449 - - *472 + - *451 + - *452 + - *473 - *19 responses: '200': @@ -63879,7 +64385,7 @@ paths: type: integer variables: type: array - items: &489 + items: &490 title: Actions Variable type: object properties: @@ -63913,7 +64419,7 @@ paths: - created_at - updated_at examples: - default: &490 + default: &491 value: total_count: 2 variables: @@ -63946,8 +64452,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -63956,11 +64462,11 @@ paths: schema: type: object properties: - enabled: &473 + enabled: &474 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *54 - selected_actions_url: *256 + selected_actions_url: *260 sha_pinning_required: *55 required: - enabled @@ -63991,8 +64497,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: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -64003,7 +64509,7 @@ paths: schema: type: object properties: - enabled: *473 + enabled: *474 allowed_actions: *54 sha_pinning_required: *55 required: @@ -64036,14 +64542,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: &474 + schema: &475 type: object properties: access_level: @@ -64061,7 +64567,7 @@ paths: required: - access_level examples: - default: &475 + default: &476 value: access_level: organization x-github: @@ -64086,15 +64592,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: application/json: - schema: *474 + schema: *475 examples: - default: *475 + default: *476 responses: '204': description: Response @@ -64118,14 +64624,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *258 + schema: *262 examples: default: value: @@ -64149,8 +64655,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: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Empty response for successful settings update @@ -64160,7 +64666,7 @@ paths: required: true content: application/json: - schema: *259 + schema: *263 examples: default: summary: Set retention days @@ -64184,8 +64690,8 @@ 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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -64193,7 +64699,7 @@ paths: application/json: schema: *56 examples: - default: *260 + default: *264 '404': *6 x-github: enabledForGitHubApps: true @@ -64212,8 +64718,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: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -64247,14 +64753,14 @@ 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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *261 + schema: *265 examples: default: *57 '403': *27 @@ -64276,13 +64782,13 @@ 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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: application/json: - schema: *262 + schema: *266 examples: default: *57 responses: @@ -64308,8 +64814,8 @@ 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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -64340,8 +64846,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: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -64373,14 +64879,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *265 + schema: *269 examples: default: *63 x-github: @@ -64403,8 +64909,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: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Success response @@ -64415,7 +64921,7 @@ paths: required: true content: application/json: - schema: *266 + schema: *270 examples: default: *63 x-github: @@ -64444,8 +64950,8 @@ paths: in: query schema: type: string - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -64489,8 +64995,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -64498,9 +65004,9 @@ paths: application/json: schema: type: array - items: *270 + items: *274 examples: - default: *271 + default: *275 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64522,8 +65028,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -64566,7 +65072,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *272 + '201': *276 '404': *6 '422': *7 '409': *112 @@ -64597,8 +65103,8 @@ 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: - - *448 - - *449 + - *451 + - *452 responses: '201': description: Response @@ -64606,7 +65112,7 @@ paths: application/json: schema: *73 examples: - default: *273 + default: *277 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64634,8 +65140,8 @@ 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: - - *448 - - *449 + - *451 + - *452 responses: '201': description: Response @@ -64643,7 +65149,7 @@ paths: application/json: schema: *73 examples: - default: *274 + default: *278 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64665,8 +65171,8 @@ 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: - - *448 - - *449 + - *451 + - *452 - *69 responses: '200': @@ -64675,7 +65181,7 @@ paths: application/json: schema: *70 examples: - default: *275 + default: *279 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64696,8 +65202,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-a-repository parameters: - - *448 - - *449 + - *451 + - *452 - *69 responses: '204': @@ -64724,8 +65230,8 @@ 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: - - *448 - - *449 + - *451 + - *452 - *69 responses: '200': *75 @@ -64750,8 +65256,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-a-repository parameters: - - *448 - - *449 + - *451 + - *452 - *69 requestBody: required: true @@ -64800,8 +65306,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-a-repository parameters: - - *448 - - *449 + - *451 + - *452 - *69 requestBody: required: true @@ -64851,11 +65357,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: - - *448 - - *449 + - *451 + - *452 - *69 responses: - '200': *276 + '200': *280 '404': *6 x-github: githubCloudOnly: false @@ -64882,10 +65388,10 @@ 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: - - *448 - - *449 + - *451 + - *452 - *69 - - *277 + - *281 responses: '200': *75 '404': *6 @@ -64913,9 +65419,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: - - *448 - - *449 - - &493 + - *451 + - *452 + - &494 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. @@ -64923,7 +65429,7 @@ paths: required: false schema: type: string - - &494 + - &495 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -64931,7 +65437,7 @@ paths: required: false schema: type: string - - &495 + - &496 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -64940,7 +65446,7 @@ paths: required: false schema: type: string - - &496 + - &497 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 @@ -64967,7 +65473,7 @@ paths: - pending - *17 - *19 - - &497 + - &498 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)." @@ -64976,7 +65482,7 @@ paths: schema: type: string format: date-time - - &476 + - &477 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -64985,13 +65491,13 @@ paths: schema: type: boolean default: false - - &498 + - &499 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &499 + - &500 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -65014,7 +65520,7 @@ paths: type: integer workflow_runs: type: array - items: &477 + items: &478 title: Workflow Run description: An invocation of a workflow type: object @@ -65131,7 +65637,7 @@ paths: type: - array - 'null' - items: &518 + items: &519 title: Pull Request Minimal type: object properties: @@ -65258,7 +65764,7 @@ paths: head_commit: anyOf: - type: 'null' - - &522 + - &523 title: Simple Commit description: A commit. type: object @@ -65332,8 +65838,8 @@ paths: - timestamp - author - committer - repository: *269 - head_repository: *269 + repository: *273 + head_repository: *273 head_repository_id: type: integer examples: @@ -65373,7 +65879,7 @@ paths: - workflow_url - pull_requests examples: - default: &500 + default: &501 value: total_count: 1 workflow_runs: @@ -65609,24 +66115,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *448 - - *449 - - &478 + - *451 + - *452 + - &479 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *476 + - *477 responses: '200': description: Response content: application/json: - schema: *477 + schema: *478 examples: - default: &481 + default: &482 value: id: 30433642 name: Build @@ -65867,9 +66373,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 responses: '204': description: Response @@ -65892,9 +66398,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: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 responses: '200': description: Response @@ -66022,15 +66528,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: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 responses: '201': description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -66057,12 +66563,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 - *17 - *19 - - *479 + - *480 responses: '200': description: Response @@ -66078,9 +66584,9 @@ paths: type: integer artifacts: type: array - items: *465 + items: *466 examples: - default: *480 + default: *481 headers: Link: *41 x-github: @@ -66104,25 +66610,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *448 - - *449 - - *478 - - &482 + - *451 + - *452 + - *479 + - &483 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *476 + - *477 responses: '200': description: Response content: application/json: - schema: *477 + schema: *478 examples: - default: *481 + default: *482 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66145,10 +66651,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: - - *448 - - *449 - - *478 - - *482 + - *451 + - *452 + - *479 + - *483 - *17 - *19 responses: @@ -66166,9 +66672,9 @@ paths: type: integer jobs: type: array - items: *483 + items: *484 examples: - default: &484 + default: &485 value: total_count: 1 jobs: @@ -66281,10 +66787,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *448 - - *449 - - *478 - - *482 + - *451 + - *452 + - *479 + - *483 responses: '302': description: Response @@ -66312,15 +66818,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 responses: '202': description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -66347,9 +66853,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: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 requestBody: required: true content: @@ -66416,15 +66922,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 responses: '202': description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -66451,9 +66957,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: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 - 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 @@ -66483,9 +66989,9 @@ paths: type: integer jobs: type: array - items: *483 + items: *484 examples: - default: *484 + default: *485 headers: Link: *41 x-github: @@ -66510,9 +67016,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 responses: '302': description: Response @@ -66539,9 +67045,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 responses: '204': description: Response @@ -66568,9 +67074,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: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 responses: '200': description: Response @@ -66639,7 +67145,7 @@ paths: items: type: object properties: - type: &602 + type: &603 type: string description: The type of reviewer. enum: @@ -66650,7 +67156,7 @@ paths: reviewer: anyOf: - *4 - - *296 + - *300 required: - environment - wait_timer @@ -66725,9 +67231,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: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 requestBody: required: true content: @@ -66777,7 +67283,7 @@ paths: application/json: schema: type: array - items: &588 + items: &589 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -66889,7 +67395,7 @@ paths: - created_at - updated_at examples: - default: &589 + default: &590 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -66945,9 +67451,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 requestBody: required: false content: @@ -66969,7 +67475,7 @@ paths: description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -66992,9 +67498,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: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 requestBody: required: false content: @@ -67016,7 +67522,7 @@ paths: description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -67049,9 +67555,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 responses: '200': description: Response @@ -67188,8 +67694,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -67207,9 +67713,9 @@ paths: type: integer secrets: type: array - items: *485 + items: *486 examples: - default: *486 + default: *487 headers: Link: *41 x-github: @@ -67234,16 +67740,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *487 + schema: *488 examples: - default: *488 + default: *489 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67265,17 +67771,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *448 - - *449 - - *279 + - *451 + - *452 + - *283 responses: '200': description: Response content: application/json: - schema: *485 + schema: *486 examples: - default: &615 + default: &616 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -67301,9 +67807,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *448 - - *449 - - *279 + - *451 + - *452 + - *283 requestBody: required: true content: @@ -67334,7 +67840,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -67360,9 +67866,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *448 - - *449 - - *279 + - *451 + - *452 + - *283 responses: '204': description: Response @@ -67387,9 +67893,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *448 - - *449 - - *472 + - *451 + - *452 + - *473 - *19 responses: '200': @@ -67406,9 +67912,9 @@ paths: type: integer variables: type: array - items: *489 + items: *490 examples: - default: *490 + default: *491 headers: Link: *41 x-github: @@ -67431,8 +67937,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -67459,7 +67965,7 @@ paths: description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -67484,17 +67990,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *448 - - *449 - - *282 + - *451 + - *452 + - *286 responses: '200': description: Response content: application/json: - schema: *489 + schema: *490 examples: - default: &616 + default: &617 value: name: USERNAME value: octocat @@ -67520,9 +68026,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *448 - - *449 - - *282 + - *451 + - *452 + - *286 requestBody: required: true content: @@ -67564,9 +68070,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *448 - - *449 - - *282 + - *451 + - *452 + - *286 responses: '204': description: Response @@ -67591,8 +68097,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -67610,7 +68116,7 @@ paths: type: integer workflows: type: array - items: &491 + items: &492 title: Workflow description: A GitHub Actions workflow type: object @@ -67728,9 +68234,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *448 - - *449 - - &492 + - *451 + - *452 + - &493 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -67745,7 +68251,7 @@ paths: description: Response content: application/json: - schema: *491 + schema: *492 examples: default: value: @@ -67778,9 +68284,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *448 - - *449 - - *492 + - *451 + - *452 + - *493 responses: '204': description: Response @@ -67805,9 +68311,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *448 - - *449 - - *492 + - *451 + - *452 + - *493 responses: '204': description: Response @@ -67858,9 +68364,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *448 - - *449 - - *492 + - *451 + - *452 + - *493 responses: '204': description: Response @@ -67887,19 +68393,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: - - *448 - - *449 - - *492 + - *451 + - *452 - *493 - *494 - *495 - *496 + - *497 - *17 - *19 - - *497 - - *476 - *498 + - *477 - *499 + - *500 responses: '200': description: Response @@ -67915,9 +68421,9 @@ paths: type: integer workflow_runs: type: array - items: *477 + items: *478 examples: - default: *500 + default: *501 headers: Link: *41 x-github: @@ -67950,9 +68456,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *448 - - *449 - - *492 + - *451 + - *452 + - *493 responses: '200': description: Response @@ -68013,8 +68519,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *448 - - *449 + - *451 + - *452 - *104 - *17 - *102 @@ -68182,8 +68688,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -68195,7 +68701,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 '404': *6 @@ -68220,8 +68726,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: - - *448 - - *449 + - *451 + - *452 - name: assignee in: path required: true @@ -68257,8 +68763,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -68370,8 +68876,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *102 - *103 @@ -68428,7 +68934,7 @@ paths: initiator: type: string examples: - default: *501 + default: *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68448,8 +68954,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -68457,7 +68963,7 @@ paths: application/json: schema: type: array - items: &502 + items: &503 title: Autolink reference description: An autolink reference. type: object @@ -68516,8 +69022,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -68556,9 +69062,9 @@ paths: description: response content: application/json: - schema: *502 + schema: *503 examples: - default: &503 + default: &504 value: id: 1 key_prefix: TICKET- @@ -68589,9 +69095,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: - - *448 - - *449 - - &504 + - *451 + - *452 + - &505 name: autolink_id description: The unique identifier of the autolink. in: path @@ -68603,9 +69109,9 @@ paths: description: Response content: application/json: - schema: *502 + schema: *503 examples: - default: *503 + default: *504 '404': *6 x-github: githubCloudOnly: false @@ -68625,9 +69131,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: - - *448 - - *449 - - *504 + - *451 + - *452 + - *505 responses: '204': description: Response @@ -68651,8 +69157,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response if Dependabot is enabled @@ -68702,8 +69208,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -68724,8 +69230,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -68745,8 +69251,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *448 - - *449 + - *451 + - *452 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -68784,7 +69290,7 @@ paths: - url protected: type: boolean - protection: &506 + protection: &507 title: Branch Protection description: Branch Protection type: object @@ -68827,7 +69333,7 @@ paths: required: - contexts - checks - enforce_admins: &509 + enforce_admins: &510 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -68844,7 +69350,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &511 + required_pull_request_reviews: &512 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -68866,7 +69372,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *296 + items: *300 apps: description: The list of apps with review dismissal access. @@ -68898,7 +69404,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *296 + items: *300 apps: description: The list of apps allowed to bypass pull request requirements. @@ -68928,7 +69434,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &508 + restrictions: &509 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -68991,7 +69497,7 @@ paths: type: string teams: type: array - items: *296 + items: *300 apps: type: array items: @@ -69221,9 +69727,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *448 - - *449 - - &507 + - *451 + - *452 + - &508 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). @@ -69237,14 +69743,14 @@ paths: description: Response content: application/json: - schema: &517 + schema: &518 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &564 + commit: &565 title: Commit description: Commit type: object @@ -69283,7 +69789,7 @@ paths: author: anyOf: - type: 'null' - - &505 + - &506 title: Git User description: Metaproperties for Git author/committer information. @@ -69304,7 +69810,7 @@ paths: committer: anyOf: - type: 'null' - - *505 + - *506 message: type: string examples: @@ -69328,7 +69834,7 @@ paths: required: - sha - url - verification: &622 + verification: &623 title: Verification type: object properties: @@ -69364,14 +69870,14 @@ paths: author: oneOf: - *4 - - *280 + - *284 type: - 'null' - object committer: oneOf: - *4 - - *280 + - *284 type: - 'null' - object @@ -69408,7 +69914,7 @@ paths: type: integer files: type: array - items: &575 + items: &576 title: Diff Entry description: Diff Entry type: object @@ -69504,7 +70010,7 @@ paths: - self protected: type: boolean - protection: *506 + protection: *507 protection_url: type: string format: uri @@ -69613,7 +70119,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *462 + '301': *463 '404': *6 x-github: githubCloudOnly: false @@ -69635,15 +70141,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response content: application/json: - schema: *506 + schema: *507 examples: default: value: @@ -69837,9 +70343,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: true content: @@ -70099,7 +70605,7 @@ paths: url: type: string format: uri - required_status_checks: &514 + required_status_checks: &515 title: Status Check Policy description: Status Check Policy type: object @@ -70180,7 +70686,7 @@ paths: items: *4 teams: type: array - items: *296 + items: *300 apps: type: array items: *5 @@ -70198,7 +70704,7 @@ paths: items: *4 teams: type: array - items: *296 + items: *300 apps: type: array items: *5 @@ -70258,7 +70764,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *508 + restrictions: *509 required_conversation_resolution: type: object properties: @@ -70370,9 +70876,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '204': description: Response @@ -70397,17 +70903,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response content: application/json: - schema: *509 + schema: *510 examples: - default: &510 + default: &511 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -70429,17 +70935,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response content: application/json: - schema: *509 + schema: *510 examples: - default: *510 + default: *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70458,9 +70964,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '204': description: Response @@ -70485,17 +70991,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response content: application/json: - schema: *511 + schema: *512 examples: - default: &512 + default: &513 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -70591,9 +71097,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: false content: @@ -70691,9 +71197,9 @@ paths: description: Response content: application/json: - schema: *511 + schema: *512 examples: - default: *512 + default: *513 '422': *15 x-github: githubCloudOnly: false @@ -70714,9 +71220,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '204': description: Response @@ -70743,17 +71249,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response content: application/json: - schema: *509 + schema: *510 examples: - default: &513 + default: &514 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -70776,17 +71282,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response content: application/json: - schema: *509 + schema: *510 examples: - default: *513 + default: *514 '404': *6 x-github: githubCloudOnly: false @@ -70806,9 +71312,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '204': description: Response @@ -70833,17 +71339,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response content: application/json: - schema: *514 + schema: *515 examples: - default: &515 + default: &516 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -70869,9 +71375,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: false content: @@ -70923,9 +71429,9 @@ paths: description: Response content: application/json: - schema: *514 + schema: *515 examples: - default: *515 + default: *516 '404': *6 '422': *15 x-github: @@ -70947,9 +71453,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '204': description: Response @@ -70973,9 +71479,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response @@ -71009,9 +71515,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: false content: @@ -71078,9 +71584,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: false content: @@ -71144,9 +71650,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: content: application/json: @@ -71212,15 +71718,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response content: application/json: - schema: *508 + schema: *509 examples: default: value: @@ -71311,9 +71817,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '204': description: Response @@ -71336,9 +71842,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: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response @@ -71348,7 +71854,7 @@ paths: type: array items: *5 examples: - default: &516 + default: &517 value: - id: 1 slug: octoapp @@ -71405,9 +71911,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: true content: @@ -71441,7 +71947,7 @@ paths: type: array items: *5 examples: - default: *516 + default: *517 '422': *15 x-github: githubCloudOnly: false @@ -71462,9 +71968,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: true content: @@ -71498,7 +72004,7 @@ paths: type: array items: *5 examples: - default: *516 + default: *517 '422': *15 x-github: githubCloudOnly: false @@ -71519,9 +72025,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: true content: @@ -71555,7 +72061,7 @@ paths: type: array items: *5 examples: - default: *516 + default: *517 '422': *15 x-github: githubCloudOnly: false @@ -71577,9 +72083,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: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response @@ -71587,9 +72093,9 @@ paths: application/json: schema: type: array - items: *296 + items: *300 examples: - default: *365 + default: *369 '404': *6 x-github: githubCloudOnly: false @@ -71609,9 +72115,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: false content: @@ -71647,9 +72153,9 @@ paths: application/json: schema: type: array - items: *296 + items: *300 examples: - default: *365 + default: *369 '422': *15 x-github: githubCloudOnly: false @@ -71670,9 +72176,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: false content: @@ -71708,9 +72214,9 @@ paths: application/json: schema: type: array - items: *296 + items: *300 examples: - default: *365 + default: *369 '422': *15 x-github: githubCloudOnly: false @@ -71731,9 +72237,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: content: application/json: @@ -71768,9 +72274,9 @@ paths: application/json: schema: type: array - items: *296 + items: *300 examples: - default: *365 + default: *369 '422': *15 x-github: githubCloudOnly: false @@ -71792,9 +72298,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: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response @@ -71804,7 +72310,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 '404': *6 x-github: githubCloudOnly: false @@ -71828,9 +72334,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: true content: @@ -71863,7 +72369,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 '422': *15 x-github: githubCloudOnly: false @@ -71888,9 +72394,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: true content: @@ -71923,7 +72429,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 '422': *15 x-github: githubCloudOnly: false @@ -71948,9 +72454,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: true content: @@ -71983,7 +72489,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 '422': *15 x-github: githubCloudOnly: false @@ -72010,9 +72516,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: true content: @@ -72034,7 +72540,7 @@ paths: description: Response content: application/json: - schema: *517 + schema: *518 examples: default: value: @@ -72148,8 +72654,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *448 - - *449 + - *451 + - *452 - *97 - *98 - *99 @@ -72163,9 +72669,9 @@ paths: application/json: schema: type: array - items: *291 + items: *295 examples: - default: *292 + default: *296 '404': *6 '500': *38 "/repos/{owner}/{repo}/bypass-requests/push-rules/{bypass_request_number}": @@ -72185,8 +72691,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *448 - - *449 + - *451 + - *452 - name: bypass_request_number in: path required: true @@ -72200,7 +72706,7 @@ paths: description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -72259,8 +72765,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *448 - - *449 + - *451 + - *452 - *97 - *98 - *99 @@ -72274,9 +72780,9 @@ paths: application/json: schema: type: array - items: *294 + items: *298 examples: - default: *295 + default: *299 '404': *6 '403': *27 '500': *38 @@ -72300,8 +72806,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *448 - - *449 + - *451 + - *452 - name: bypass_request_number in: path required: true @@ -72313,7 +72819,7 @@ paths: description: A single bypass request. content: application/json: - schema: *294 + schema: *298 examples: default: value: @@ -72371,8 +72877,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *448 - - *449 + - *451 + - *452 - name: bypass_request_number in: path required: true @@ -72443,8 +72949,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *448 - - *449 + - *451 + - *452 - name: bypass_response_id in: path required: true @@ -72477,8 +72983,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -72757,7 +73263,7 @@ paths: description: Response content: application/json: - schema: &519 + schema: &520 title: CheckRun description: A check performed on the code of a given code change type: object @@ -72892,8 +73398,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *518 - deployment: &841 + items: *519 + deployment: &843 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -73180,9 +73686,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *448 - - *449 - - &520 + - *451 + - *452 + - &521 name: check_run_id description: The unique identifier of the check run. in: path @@ -73194,9 +73700,9 @@ paths: description: Response content: application/json: - schema: *519 + schema: *520 examples: - default: &521 + default: &522 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -73296,9 +73802,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *448 - - *449 - - *520 + - *451 + - *452 + - *521 requestBody: required: true content: @@ -73538,9 +74044,9 @@ paths: description: Response content: application/json: - schema: *519 + schema: *520 examples: - default: *521 + default: *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73560,9 +74066,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *448 - - *449 - - *520 + - *451 + - *452 + - *521 - *17 - *19 responses: @@ -73672,15 +74178,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *448 - - *449 - - *520 + - *451 + - *452 + - *521 responses: '201': description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -73718,8 +74224,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -73741,7 +74247,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &523 + schema: &524 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -73823,12 +74329,12 @@ paths: type: - array - 'null' - items: *518 + items: *519 app: anyOf: - type: 'null' - *5 - repository: *269 + repository: *273 created_at: type: - string @@ -73839,7 +74345,7 @@ paths: - string - 'null' format: date-time - head_commit: *522 + head_commit: *523 latest_check_runs_count: type: integer check_runs_url: @@ -73867,7 +74373,7 @@ paths: - check_runs_url - pull_requests examples: - default: &524 + default: &525 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -74158,9 +74664,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *523 + schema: *524 examples: - default: *524 + default: *525 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74179,8 +74685,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -74241,7 +74747,7 @@ paths: required: - app_id - setting - repository: *269 + repository: *273 examples: default: value: @@ -74489,9 +74995,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *448 - - *449 - - &525 + - *451 + - *452 + - &526 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -74503,9 +75009,9 @@ paths: description: Response content: application/json: - schema: *523 + schema: *524 examples: - default: *524 + default: *525 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74528,17 +75034,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: - - *448 - - *449 - - *525 - - &570 + - *451 + - *452 + - *526 + - &571 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &571 + - &572 name: status description: Returns check runs with the specified `status`. in: query @@ -74577,9 +75083,9 @@ paths: type: integer check_runs: type: array - items: *519 + items: *520 examples: - default: &572 + default: &573 value: total_count: 1 check_runs: @@ -74681,15 +75187,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *448 - - *449 - - *525 + - *451 + - *452 + - *526 responses: '201': description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -74716,21 +75222,21 @@ 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: - - *448 - - *449 - - *300 - - *301 + - *451 + - *452 + - *304 + - *305 - *19 - *17 - - &541 + - &542 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: *526 - - &542 + schema: *527 + - &543 name: pr description: The number of the pull request for the results you want to list. in: query @@ -74755,13 +75261,13 @@ paths: be returned. in: query required: false - schema: *302 + schema: *306 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *527 + schema: *528 responses: '200': description: Response @@ -74777,7 +75283,7 @@ paths: updated_at: *127 url: *124 html_url: *125 - instances_url: *528 + instances_url: *529 state: *107 fixed_at: *129 dismissed_by: @@ -74785,11 +75291,11 @@ paths: - type: 'null' - *4 dismissed_at: *128 - dismissed_reason: *529 - dismissed_comment: *530 - rule: *531 - tool: *532 - most_recent_instance: *533 + dismissed_reason: *530 + dismissed_comment: *531 + rule: *532 + tool: *533 + most_recent_instance: *534 dismissal_approved_by: anyOf: - type: 'null' @@ -74912,7 +75418,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &534 + '403': &535 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -74939,9 +75445,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: - - *448 - - *449 - - &535 + - *451 + - *452 + - &536 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -74955,7 +75461,7 @@ paths: description: Response content: application/json: - schema: &536 + schema: &537 type: object properties: number: *119 @@ -74963,7 +75469,7 @@ paths: updated_at: *127 url: *124 html_url: *125 - instances_url: *528 + instances_url: *529 state: *107 fixed_at: *129 dismissed_by: @@ -74971,8 +75477,8 @@ paths: - type: 'null' - *4 dismissed_at: *128 - dismissed_reason: *529 - dismissed_comment: *530 + dismissed_reason: *530 + dismissed_comment: *531 rule: type: object properties: @@ -75034,8 +75540,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *532 - most_recent_instance: *533 + tool: *533 + most_recent_instance: *534 dismissal_approved_by: anyOf: - type: 'null' @@ -75131,7 +75637,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *534 + '403': *535 '404': *6 '503': *184 x-github: @@ -75151,9 +75657,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: - - *448 - - *449 - - *535 + - *451 + - *452 + - *536 requestBody: required: true content: @@ -75168,8 +75674,8 @@ paths: enum: - open - dismissed - dismissed_reason: *529 - dismissed_comment: *530 + dismissed_reason: *530 + dismissed_comment: *531 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -75188,7 +75694,7 @@ paths: description: Response content: application/json: - schema: *536 + schema: *537 examples: default: value: @@ -75264,7 +75770,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &540 + '403': &541 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -75291,15 +75797,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: - - *448 - - *449 - - *535 + - *451 + - *452 + - *536 responses: '200': description: Response content: application/json: - schema: &537 + schema: &538 type: object properties: status: @@ -75326,13 +75832,13 @@ paths: - description - started_at examples: - default: &538 + default: &539 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &539 + '400': &540 description: Bad Request content: application/json: @@ -75343,7 +75849,7 @@ 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': *534 + '403': *535 '404': *6 '503': *184 x-github: @@ -75368,29 +75874,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: - - *448 - - *449 - - *535 + - *451 + - *452 + - *536 responses: '200': description: OK content: application/json: - schema: *537 + schema: *538 examples: - default: *538 + default: *539 '202': description: Accepted content: application/json: - schema: *537 + schema: *538 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *539 + '400': *540 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -75422,9 +75928,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: - - *448 - - *449 - - *535 + - *451 + - *452 + - *536 requestBody: required: false content: @@ -75470,8 +75976,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *539 - '403': *540 + '400': *540 + '403': *541 '404': *6 '422': description: Unprocessable Entity @@ -75495,13 +76001,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: - - *448 - - *449 - - *535 + - *451 + - *452 + - *536 - *19 - *17 - - *541 - *542 + - *543 responses: '200': description: Response @@ -75509,7 +76015,7 @@ paths: application/json: schema: type: array - items: *533 + items: *534 examples: default: value: @@ -75548,7 +76054,7 @@ paths: end_column: 50 classifications: - source - '403': *534 + '403': *535 '404': *6 '503': *184 x-github: @@ -75582,25 +76088,25 @@ 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: - - *448 - - *449 - - *300 - - *301 + - *451 + - *452 + - *304 + - *305 - *19 - *17 - - *542 + - *543 - 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: *526 + schema: *527 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &545 + schema: &546 type: string description: An identifier for the upload. examples: @@ -75622,23 +76128,23 @@ paths: application/json: schema: type: array - items: &546 + items: &547 type: object properties: - ref: *526 - commit_sha: &554 + ref: *527 + commit_sha: &555 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: *543 + analysis_key: *544 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *544 + category: *545 error: type: string examples: @@ -75663,8 +76169,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *545 - tool: *532 + sarif_id: *546 + tool: *533 deletable: type: boolean warning: @@ -75726,7 +76232,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *534 + '403': *535 '404': *6 '503': *184 x-github: @@ -75762,8 +76268,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: - - *448 - - *449 + - *451 + - *452 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -75776,7 +76282,7 @@ paths: description: Response content: application/json: - schema: *546 + schema: *547 examples: response: summary: application/json response @@ -75830,7 +76336,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *534 + '403': *535 '404': *6 '422': description: Response if analysis could not be processed @@ -75917,8 +76423,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: - - *448 - - *449 + - *451 + - *452 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -75974,7 +76480,7 @@ 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': *540 + '403': *541 '404': *6 '503': *184 x-github: @@ -75996,8 +76502,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -76005,7 +76511,7 @@ paths: application/json: schema: type: array - items: &547 + items: &548 title: CodeQL Database description: A CodeQL database. type: object @@ -76117,7 +76623,7 @@ 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': *534 + '403': *535 '404': *6 '503': *184 x-github: @@ -76146,8 +76652,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: - - *448 - - *449 + - *451 + - *452 - name: language in: path description: The language of the CodeQL database. @@ -76159,7 +76665,7 @@ paths: description: Response content: application/json: - schema: *547 + schema: *548 examples: default: value: @@ -76191,9 +76697,9 @@ 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': &577 + '302': &578 description: Found - '403': *534 + '403': *535 '404': *6 '503': *184 x-github: @@ -76215,8 +76721,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *448 - - *449 + - *451 + - *452 - name: language in: path description: The language of the CodeQL database. @@ -76226,7 +76732,7 @@ paths: responses: '204': description: Response - '403': *540 + '403': *541 '404': *6 '503': *184 x-github: @@ -76254,8 +76760,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -76264,7 +76770,7 @@ paths: type: object additionalProperties: false properties: - language: &548 + language: &549 type: string description: The language targeted by the CodeQL query enum: @@ -76343,7 +76849,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &552 + schema: &553 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -76353,7 +76859,7 @@ paths: description: The ID of the variant analysis. controller_repo: *113 actor: *4 - query_language: *548 + query_language: *549 query_pack_url: type: string description: The download url for the query pack. @@ -76401,7 +76907,7 @@ paths: items: type: object properties: - repository: &549 + repository: &550 title: Repository Identifier description: Repository Identifier type: object @@ -76443,7 +76949,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &553 + analysis_status: &554 type: string description: The new status of the CodeQL variant analysis repository task. @@ -76475,7 +76981,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &550 + access_mismatch_repos: &551 type: object properties: repository_count: @@ -76490,7 +76996,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: *549 + items: *550 required: - repository_count - repositories @@ -76513,8 +77019,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *550 - over_limit_repos: *550 + no_codeql_db_repos: *551 + over_limit_repos: *551 required: - access_mismatch_repos - not_found_repos @@ -76530,7 +77036,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &551 + value: &552 summary: Default response value: id: 1 @@ -76682,10 +77188,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *551 + value: *552 repository_lists: summary: Response for a successful variant analysis submission - value: *551 + value: *552 '404': *6 '422': description: Unable to process variant analysis submission @@ -76713,8 +77219,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: - - *448 - - *449 + - *451 + - *452 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -76726,9 +77232,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *553 examples: - default: *551 + default: *552 '404': *6 '503': *184 x-github: @@ -76751,7 +77257,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: - - *448 + - *451 - name: repo in: path description: The name of the controller repository. @@ -76786,7 +77292,7 @@ paths: type: object properties: repository: *113 - analysis_status: *553 + analysis_status: *554 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -76911,8 +77417,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -77005,7 +77511,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *534 + '403': *535 '404': *6 '503': *184 x-github: @@ -77026,8 +77532,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -77096,7 +77602,7 @@ paths: description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -77121,7 +77627,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *540 + '403': *541 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -77192,8 +77698,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -77201,7 +77707,7 @@ paths: schema: type: object properties: - commit_sha: *554 + commit_sha: *555 ref: type: string description: |- @@ -77261,7 +77767,7 @@ paths: schema: type: object properties: - id: *545 + id: *546 url: type: string description: The REST API URL for checking the status of the upload. @@ -77275,7 +77781,7 @@ 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': *540 + '403': *541 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -77298,8 +77804,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: - - *448 - - *449 + - *451 + - *452 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -77347,7 +77853,7 @@ 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': *534 + '403': *535 '404': description: Not Found if the sarif id does not match any upload '503': *184 @@ -77372,8 +77878,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -77454,8 +77960,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *448 - - *449 + - *451 + - *452 - 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 @@ -77583,8 +78089,8 @@ paths: parameters: - *17 - *19 - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -77600,7 +78106,7 @@ paths: type: integer codespaces: type: array - items: *356 + items: *360 examples: default: value: @@ -77898,8 +78404,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -77963,17 +78469,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '400': *14 '401': *23 '403': *27 @@ -78002,8 +78508,8 @@ paths: parameters: - *17 - *19 - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -78067,8 +78573,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: - - *448 - - *449 + - *451 + - *452 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -78105,9 +78611,9 @@ paths: type: integer machines: type: array - items: *556 + items: *557 examples: - default: &793 + default: &795 value: total_count: 2 machines: @@ -78147,8 +78653,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *448 - - *449 + - *451 + - *452 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -78235,8 +78741,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: - - *448 - - *449 + - *451 + - *452 - 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 @@ -78305,8 +78811,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -78324,7 +78830,7 @@ paths: type: integer secrets: type: array - items: &560 + items: &561 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -78345,7 +78851,7 @@ paths: - created_at - updated_at examples: - default: *557 + default: *558 headers: Link: *41 x-github: @@ -78368,16 +78874,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *558 + schema: *559 examples: - default: *559 + default: *560 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -78397,17 +78903,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *448 - - *449 - - *279 + - *451 + - *452 + - *283 responses: '200': description: Response content: application/json: - schema: *560 + schema: *561 examples: - default: *561 + default: *562 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78427,9 +78933,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: - - *448 - - *449 - - *279 + - *451 + - *452 + - *283 requestBody: required: true content: @@ -78457,7 +78963,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -78481,9 +78987,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *448 - - *449 - - *279 + - *451 + - *452 + - *283 responses: '204': description: Response @@ -78511,8 +79017,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *448 - - *449 + - *451 + - *452 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -78550,7 +79056,7 @@ paths: application/json: schema: type: array - items: &562 + items: &563 title: Collaborator description: Collaborator type: object @@ -78743,8 +79249,8 @@ 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: - - *448 - - *449 + - *451 + - *452 - *132 responses: '204': @@ -78791,8 +79297,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *448 - - *449 + - *451 + - *452 - *132 requestBody: required: false @@ -78819,7 +79325,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &635 + schema: &636 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -78831,7 +79337,7 @@ paths: format: int64 examples: - 42 - repository: *269 + repository: *273 invitee: anyOf: - type: 'null' @@ -79007,7 +79513,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *244 + schema: *248 '403': *27 x-github: triggersNotification: true @@ -79047,8 +79553,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *448 - - *449 + - *451 + - *452 - *132 responses: '204': @@ -79080,8 +79586,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *448 - - *449 + - *451 + - *452 - *132 responses: '200': @@ -79102,7 +79608,7 @@ paths: user: anyOf: - type: 'null' - - *562 + - *563 required: - permission - role_name @@ -79156,8 +79662,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -79167,7 +79673,7 @@ paths: application/json: schema: type: array - items: &563 + items: &564 title: Commit Comment description: Commit Comment type: object @@ -79208,8 +79714,8 @@ paths: updated_at: type: string format: date-time - author_association: *205 - reactions: *206 + author_association: *206 + reactions: *207 required: - url - html_url @@ -79225,7 +79731,7 @@ paths: - created_at - updated_at examples: - default: &566 + default: &567 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -79284,17 +79790,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 responses: '200': description: Response content: application/json: - schema: *563 + schema: *564 examples: - default: &567 + default: &568 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -79351,9 +79857,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 requestBody: required: true content: @@ -79375,7 +79881,7 @@ paths: description: Response content: application/json: - schema: *563 + schema: *564 examples: default: value: @@ -79426,9 +79932,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 responses: '204': description: Response @@ -79449,9 +79955,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 - 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. @@ -79477,9 +79983,9 @@ paths: application/json: schema: type: array - items: *437 + items: *440 examples: - default: *439 + default: *442 headers: Link: *41 '404': *6 @@ -79500,9 +80006,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 requestBody: required: true content: @@ -79534,16 +80040,16 @@ paths: description: Reaction exists content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '201': description: Reaction created content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '422': *15 x-github: githubCloudOnly: false @@ -79565,10 +80071,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *448 - - *449 - - *217 - - *440 + - *451 + - *452 + - *218 + - *443 responses: '204': description: Response @@ -79617,8 +80123,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *448 - - *449 + - *451 + - *452 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -79674,9 +80180,9 @@ paths: application/json: schema: type: array - items: *564 + items: *565 examples: - default: &684 + default: &686 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -79770,9 +80276,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *448 - - *449 - - &565 + - *451 + - *452 + - &566 name: commit_sha description: The SHA of the commit. in: path @@ -79844,9 +80350,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *448 - - *449 - - *565 + - *451 + - *452 + - *566 - *17 - *19 responses: @@ -79856,9 +80362,9 @@ paths: application/json: schema: type: array - items: *563 + items: *564 examples: - default: *566 + default: *567 headers: Link: *41 x-github: @@ -79886,9 +80392,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *448 - - *449 - - *565 + - *451 + - *452 + - *566 requestBody: required: true content: @@ -79923,9 +80429,9 @@ paths: description: Response content: application/json: - schema: *563 + schema: *564 examples: - default: *567 + default: *568 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -79953,9 +80459,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: - - *448 - - *449 - - *565 + - *451 + - *452 + - *566 - *17 - *19 responses: @@ -79965,9 +80471,9 @@ paths: application/json: schema: type: array - items: *568 + items: *569 examples: - default: &676 + default: &678 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -80504,11 +81010,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *448 - - *449 + - *451 + - *452 - *19 - *17 - - &569 + - &570 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)" @@ -80523,9 +81029,9 @@ paths: description: Response content: application/json: - schema: *564 + schema: *565 examples: - default: &662 + default: &664 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -80638,11 +81144,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: - - *448 - - *449 - - *569 + - *451 + - *452 - *570 - *571 + - *572 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -80676,9 +81182,9 @@ paths: type: integer check_runs: type: array - items: *519 + items: *520 examples: - default: *572 + default: *573 headers: Link: *41 x-github: @@ -80703,9 +81209,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: - - *448 - - *449 - - *569 + - *451 + - *452 + - *570 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -80713,7 +81219,7 @@ paths: schema: type: integer example: 1 - - *570 + - *571 - *17 - *19 responses: @@ -80731,7 +81237,7 @@ paths: type: integer check_suites: type: array - items: *523 + items: *524 examples: default: value: @@ -80931,9 +81437,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: - - *448 - - *449 - - *569 + - *451 + - *452 + - *570 - *17 - *19 responses: @@ -81004,7 +81510,7 @@ paths: type: string total_count: type: integer - repository: *269 + repository: *273 commit_url: type: string format: uri @@ -81135,9 +81641,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *448 - - *449 - - *569 + - *451 + - *452 + - *570 - *17 - *19 responses: @@ -81147,7 +81653,7 @@ paths: application/json: schema: type: array - items: &738 + items: &740 title: Status description: The status of a commit. type: object @@ -81228,7 +81734,7 @@ paths: site_admin: false headers: Link: *41 - '301': *462 + '301': *463 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81256,8 +81762,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -81290,11 +81796,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *573 + - *574 code_of_conduct_file: anyOf: - type: 'null' - - &574 + - &575 title: Community Health File type: object properties: @@ -81310,23 +81816,23 @@ paths: license: anyOf: - type: 'null' - - *219 + - *220 contributing: anyOf: - type: 'null' - - *574 + - *575 readme: anyOf: - type: 'null' - - *574 + - *575 issue_template: anyOf: - type: 'null' - - *574 + - *575 pull_request_template: anyOf: - type: 'null' - - *574 + - *575 required: - code_of_conduct - code_of_conduct_file @@ -81455,8 +81961,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *448 - - *449 + - *451 + - *452 - *19 - *17 - name: basehead @@ -81504,8 +82010,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *564 - merge_base_commit: *564 + base_commit: *565 + merge_base_commit: *565 status: type: string enum: @@ -81529,10 +82035,10 @@ paths: - 6 commits: type: array - items: *564 + items: *565 files: type: array - items: *575 + items: *576 required: - url - html_url @@ -81818,8 +82324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *448 - - *449 + - *451 + - *452 - name: path description: path parameter in: path @@ -81972,7 +82478,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &576 + response-if-content-is-a-file: &577 summary: Response if content is a file value: type: file @@ -82109,7 +82615,7 @@ paths: - size - type - url - - &689 + - &691 title: Content File description: Content File type: object @@ -82327,7 +82833,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *576 + response-if-content-is-a-file: *577 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -82396,7 +82902,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *577 + '302': *578 '304': *35 x-github: githubCloudOnly: false @@ -82419,8 +82925,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *448 - - *449 + - *451 + - *452 - name: path description: path parameter in: path @@ -82515,7 +83021,7 @@ paths: description: Response content: application/json: - schema: &578 + schema: &579 title: File Commit description: File Commit type: object @@ -82671,7 +83177,7 @@ paths: description: Response content: application/json: - schema: *578 + schema: *579 examples: example-for-creating-a-file: value: @@ -82725,7 +83231,7 @@ paths: schema: oneOf: - *3 - - &617 + - &618 description: Repository rule violation was detected type: object properties: @@ -82746,7 +83252,7 @@ paths: items: type: object properties: - placeholder_id: &730 + placeholder_id: &732 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -82778,8 +83284,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *448 - - *449 + - *451 + - *452 - name: path description: path parameter in: path @@ -82840,7 +83346,7 @@ paths: description: Response content: application/json: - schema: *578 + schema: *579 examples: default: value: @@ -82895,8 +83401,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *448 - - *449 + - *451 + - *452 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -83020,22 +83526,22 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *448 - - *449 - - *316 - - *317 - - *318 - - *319 + - *451 + - *452 + - *320 + - *321 + - *322 + - *323 - 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 - - *320 - - *579 - - *321 - - *322 + - *324 + - *580 + - *325 + - *326 - *104 - name: per_page description: The number of results per page (max 100). For more information, @@ -83054,7 +83560,7 @@ paths: application/json: schema: type: array - items: &582 + items: &583 type: object description: A Dependabot alert. properties: @@ -83104,7 +83610,7 @@ paths: - direct - transitive - - security_advisory: *580 + security_advisory: *581 security_vulnerability: *123 url: *124 html_url: *125 @@ -83135,7 +83641,7 @@ paths: dismissal. maxLength: 280 fixed_at: *129 - auto_dismissed_at: *581 + auto_dismissed_at: *582 required: - number - state @@ -83365,9 +83871,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *448 - - *449 - - &583 + - *451 + - *452 + - &584 name: alert_number in: path description: |- @@ -83382,7 +83888,7 @@ paths: description: Response content: application/json: - schema: *582 + schema: *583 examples: default: value: @@ -83495,9 +84001,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *448 - - *449 - - *583 + - *451 + - *452 + - *584 requestBody: required: true content: @@ -83542,7 +84048,7 @@ paths: description: Response content: application/json: - schema: *582 + schema: *583 examples: default: value: @@ -83671,8 +84177,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -83690,7 +84196,7 @@ paths: type: integer secrets: type: array - items: &586 + items: &587 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -83744,16 +84250,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *584 + schema: *585 examples: - default: *585 + default: *586 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83773,15 +84279,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *448 - - *449 - - *279 + - *451 + - *452 + - *283 responses: '200': description: Response content: application/json: - schema: *586 + schema: *587 examples: default: value: @@ -83807,9 +84313,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *448 - - *449 - - *279 + - *451 + - *452 + - *283 requestBody: required: true content: @@ -83837,7 +84343,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -83861,9 +84367,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *448 - - *449 - - *279 + - *451 + - *452 + - *283 responses: '204': description: Response @@ -83885,8 +84391,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: - - *448 - - *449 + - *451 + - *452 - 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 @@ -84060,8 +84566,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -84321,8 +84827,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -84405,7 +84911,7 @@ paths: - version - url additionalProperties: false - metadata: &587 + metadata: &588 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -84444,7 +84950,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *587 + metadata: *588 resolved: type: object description: A collection of resolved package dependencies. @@ -84458,7 +84964,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *587 + metadata: *588 relationship: type: string description: A notation of whether a dependency is requested @@ -84591,8 +85097,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *448 - - *449 + - *451 + - *452 - name: sha description: The SHA recorded at creation time. in: query @@ -84633,9 +85139,9 @@ paths: application/json: schema: type: array - items: *588 + items: *589 examples: - default: *589 + default: *590 headers: Link: *41 x-github: @@ -84701,8 +85207,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -84784,7 +85290,7 @@ paths: description: Response content: application/json: - schema: *588 + schema: *589 examples: simple-example: summary: Simple example @@ -84857,9 +85363,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *448 - - *449 - - &590 + - *451 + - *452 + - &591 name: deployment_id description: deployment_id parameter in: path @@ -84871,7 +85377,7 @@ paths: description: Response content: application/json: - schema: *588 + schema: *589 examples: default: value: @@ -84936,9 +85442,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *448 - - *449 - - *590 + - *451 + - *452 + - *591 responses: '204': description: Response @@ -84960,9 +85466,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *448 - - *449 - - *590 + - *451 + - *452 + - *591 - *17 - *19 responses: @@ -84972,7 +85478,7 @@ paths: application/json: schema: type: array - items: &591 + items: &592 title: Deployment Status description: The status of a deployment. type: object @@ -85136,9 +85642,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *448 - - *449 - - *590 + - *451 + - *452 + - *591 requestBody: required: true content: @@ -85213,9 +85719,9 @@ paths: description: Response content: application/json: - schema: *591 + schema: *592 examples: - default: &592 + default: &593 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -85271,9 +85777,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *448 - - *449 - - *590 + - *451 + - *452 + - *591 - name: status_id in: path required: true @@ -85284,9 +85790,9 @@ paths: description: Response content: application/json: - schema: *591 + schema: *592 examples: - default: *592 + default: *593 '404': *6 x-github: githubCloudOnly: false @@ -85313,12 +85819,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 - - *593 + - *451 + - *452 - *594 - *595 - *596 + - *597 - *17 - *19 responses: @@ -85328,9 +85834,9 @@ paths: application/json: schema: type: array - items: *597 + items: *598 examples: - default: *598 + default: *599 '404': *6 '403': *27 '500': *38 @@ -85354,8 +85860,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *451 + - *452 - name: alert_number in: path required: true @@ -85367,7 +85873,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *597 + schema: *598 examples: default: value: @@ -85423,8 +85929,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *451 + - *452 - name: alert_number in: path required: true @@ -85483,12 +85989,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *451 + - *452 - *97 - *98 - *99 - - *599 + - *600 - *17 - *19 responses: @@ -85498,9 +86004,9 @@ paths: application/json: schema: type: array - items: *600 + items: *601 examples: - default: *601 + default: *602 '404': *6 '403': *27 '500': *38 @@ -85525,8 +86031,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *451 + - *452 - name: alert_number in: path required: true @@ -85538,7 +86044,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *600 + schema: *601 examples: default: value: @@ -85596,8 +86102,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *451 + - *452 - name: alert_number in: path required: true @@ -85666,8 +86172,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -85724,8 +86230,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -85743,7 +86249,7 @@ paths: - 5 environments: type: array - items: &603 + items: &604 title: Environment description: Details of a deployment environment type: object @@ -85805,7 +86311,7 @@ paths: type: string examples: - wait_timer - wait_timer: &605 + wait_timer: &606 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -85847,11 +86353,11 @@ paths: items: type: object properties: - type: *602 + type: *603 reviewer: anyOf: - *4 - - *296 + - *300 required: - id - node_id @@ -85874,7 +86380,7 @@ paths: - id - node_id - type - deployment_branch_policy: &606 + deployment_branch_policy: &607 type: - object - 'null' @@ -85991,9 +86497,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *448 - - *449 - - &604 + - *451 + - *452 + - &605 name: environment_name in: path required: true @@ -86006,9 +86512,9 @@ paths: description: Response content: application/json: - schema: *603 + schema: *604 examples: - default: &607 + default: &608 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -86092,9 +86598,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *448 - - *449 - - *604 + - *451 + - *452 + - *605 requestBody: required: false content: @@ -86104,7 +86610,7 @@ paths: - object - 'null' properties: - wait_timer: *605 + wait_timer: *606 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -86123,14 +86629,14 @@ paths: items: type: object properties: - type: *602 + type: *603 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *606 + deployment_branch_policy: *607 additionalProperties: false examples: default: @@ -86150,9 +86656,9 @@ paths: description: Response content: application/json: - schema: *603 + schema: *604 examples: - default: *607 + default: *608 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -86176,9 +86682,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *448 - - *449 - - *604 + - *451 + - *452 + - *605 responses: '204': description: Default response @@ -86203,9 +86709,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *448 - - *449 - - *604 + - *451 + - *452 + - *605 - *17 - *19 responses: @@ -86224,7 +86730,7 @@ paths: - 2 branch_policies: type: array - items: &608 + items: &609 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -86285,9 +86791,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *448 - - *449 - - *604 + - *451 + - *452 + - *605 requestBody: required: true content: @@ -86335,9 +86841,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *609 examples: - example-wildcard: &609 + example-wildcard: &610 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -86379,10 +86885,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *448 - - *449 - - *604 - - &610 + - *451 + - *452 + - *605 + - &611 name: branch_policy_id in: path required: true @@ -86394,9 +86900,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *609 examples: - default: *609 + default: *610 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86415,10 +86921,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *448 - - *449 - - *604 - - *610 + - *451 + - *452 + - *605 + - *611 requestBody: required: true content: @@ -86447,9 +86953,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *609 examples: - default: *609 + default: *610 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86468,10 +86974,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *448 - - *449 - - *604 - - *610 + - *451 + - *452 + - *605 + - *611 responses: '204': description: Response @@ -86496,9 +87002,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: - - *604 - - *449 - - *448 + - *605 + - *452 + - *451 responses: '200': description: List of deployment protection rules @@ -86515,7 +87021,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &611 + items: &612 title: Deployment protection rule description: Deployment protection rule type: object @@ -86537,7 +87043,7 @@ paths: for the environment. examples: - true - app: &612 + app: &613 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -86640,9 +87146,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: - - *604 - - *449 - - *448 + - *605 + - *452 + - *451 requestBody: content: application/json: @@ -86663,9 +87169,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *611 + schema: *612 examples: - default: &613 + default: &614 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -86700,9 +87206,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: - - *604 - - *449 - - *448 + - *605 + - *452 + - *451 - *19 - *17 responses: @@ -86722,7 +87228,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *612 + items: *613 examples: default: value: @@ -86757,10 +87263,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: - - *448 - - *449 - - *604 - - &614 + - *451 + - *452 + - *605 + - &615 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -86772,9 +87278,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *612 examples: - default: *613 + default: *614 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86795,10 +87301,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: - - *604 - - *449 - - *448 - - *614 + - *605 + - *452 + - *451 + - *615 responses: '204': description: Response @@ -86824,9 +87330,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *448 - - *449 - - *604 + - *451 + - *452 + - *605 - *17 - *19 responses: @@ -86844,9 +87350,9 @@ paths: type: integer secrets: type: array - items: *485 + items: *486 examples: - default: *486 + default: *487 headers: Link: *41 x-github: @@ -86871,17 +87377,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *448 - - *449 - - *604 + - *451 + - *452 + - *605 responses: '200': description: Response content: application/json: - schema: *487 + schema: *488 examples: - default: *488 + default: *489 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86903,18 +87409,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *448 - - *449 - - *604 - - *279 + - *451 + - *452 + - *605 + - *283 responses: '200': description: Response content: application/json: - schema: *485 + schema: *486 examples: - default: *615 + default: *616 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86936,10 +87442,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *448 - - *449 - - *604 - - *279 + - *451 + - *452 + - *605 + - *283 requestBody: required: true content: @@ -86970,7 +87476,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -86996,10 +87502,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *448 - - *449 - - *604 - - *279 + - *451 + - *452 + - *605 + - *283 responses: '204': description: Default response @@ -87024,10 +87530,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *448 - - *449 - - *604 - - *472 + - *451 + - *452 + - *605 + - *473 - *19 responses: '200': @@ -87044,9 +87550,9 @@ paths: type: integer variables: type: array - items: *489 + items: *490 examples: - default: *490 + default: *491 headers: Link: *41 x-github: @@ -87069,9 +87575,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *448 - - *449 - - *604 + - *451 + - *452 + - *605 requestBody: required: true content: @@ -87098,7 +87604,7 @@ paths: description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -87123,18 +87629,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *448 - - *449 - - *604 - - *282 + - *451 + - *452 + - *605 + - *286 responses: '200': description: Response content: application/json: - schema: *489 + schema: *490 examples: - default: *616 + default: *617 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87155,10 +87661,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *448 - - *449 - - *282 - - *604 + - *451 + - *452 + - *286 + - *605 requestBody: required: true content: @@ -87200,10 +87706,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *448 - - *449 - - *282 - - *604 + - *451 + - *452 + - *286 + - *605 responses: '204': description: Response @@ -87225,8 +87731,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -87236,7 +87742,7 @@ paths: application/json: schema: type: array - items: *229 + items: *230 examples: 200-response: value: @@ -87294,8 +87800,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *448 - - *449 + - *451 + - *452 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -87317,7 +87823,7 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: default: value: @@ -87454,8 +87960,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: false content: @@ -87488,9 +87994,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *462 examples: - default: *463 + default: *464 '400': *14 '422': *15 '403': *27 @@ -87511,8 +88017,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -87571,8 +88077,8 @@ paths: application/json: schema: oneOf: - - *244 - - *617 + - *248 + - *618 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87597,8 +88103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *448 - - *449 + - *451 + - *452 - name: file_sha in: path required: true @@ -87698,8 +88204,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -87808,7 +88314,7 @@ paths: description: Response content: application/json: - schema: &618 + schema: &619 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -88035,15 +88541,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *448 - - *449 - - *565 + - *451 + - *452 + - *566 responses: '200': description: Response content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -88099,9 +88605,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *448 - - *449 - - &619 + - *451 + - *452 + - &620 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. @@ -88118,7 +88624,7 @@ paths: application/json: schema: type: array - items: &620 + items: &621 title: Git Reference description: Git references within a repository type: object @@ -88194,17 +88700,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *448 - - *449 - - *619 + - *451 + - *452 + - *620 responses: '200': description: Response content: application/json: - schema: *620 + schema: *621 examples: - default: &621 + default: &622 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -88233,8 +88739,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -88263,9 +88769,9 @@ paths: description: Response content: application/json: - schema: *620 + schema: *621 examples: - default: *621 + default: *622 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -88291,9 +88797,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *448 - - *449 - - *619 + - *451 + - *452 + - *620 requestBody: required: true content: @@ -88322,9 +88828,9 @@ paths: description: Response content: application/json: - schema: *620 + schema: *621 examples: - default: *621 + default: *622 '422': *15 '409': *112 x-github: @@ -88342,9 +88848,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *448 - - *449 - - *619 + - *451 + - *452 + - *620 responses: '204': description: Response @@ -88399,8 +88905,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -88467,7 +88973,7 @@ paths: description: Response content: application/json: - schema: &623 + schema: &624 title: Git Tag description: Metadata for a Git tag type: object @@ -88523,7 +89029,7 @@ paths: - sha - type - url - verification: *622 + verification: *623 required: - sha - url @@ -88533,7 +89039,7 @@ paths: - tag - message examples: - default: &624 + default: &625 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -88606,8 +89112,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *448 - - *449 + - *451 + - *452 - name: tag_sha in: path required: true @@ -88618,9 +89124,9 @@ paths: description: Response content: application/json: - schema: *623 + schema: *624 examples: - default: *624 + default: *625 '404': *6 '409': *112 x-github: @@ -88644,8 +89150,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -88719,7 +89225,7 @@ paths: description: Response content: application/json: - schema: &625 + schema: &626 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -88821,8 +89327,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *448 - - *449 + - *451 + - *452 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -88845,7 +89351,7 @@ paths: description: Response content: application/json: - schema: *625 + schema: *626 examples: default-response: summary: Default response @@ -88904,8 +89410,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -88915,7 +89421,7 @@ paths: application/json: schema: type: array - items: &626 + items: &627 title: Webhook description: Webhooks for repositories. type: object @@ -88978,7 +89484,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &872 + last_response: &874 title: Hook Response type: object properties: @@ -89055,8 +89561,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: false content: @@ -89109,9 +89615,9 @@ paths: description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: &627 + default: &628 value: type: Repository id: 12345678 @@ -89159,17 +89665,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 responses: '200': description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: *627 + default: *628 '404': *6 x-github: githubCloudOnly: false @@ -89189,9 +89695,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 requestBody: required: true content: @@ -89236,9 +89742,9 @@ paths: description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: *627 + default: *628 '422': *15 '404': *6 x-github: @@ -89259,9 +89765,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 responses: '204': description: Response @@ -89285,9 +89791,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: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 responses: '200': description: Response @@ -89314,9 +89820,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: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 requestBody: required: false content: @@ -89360,11 +89866,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 - *17 - - *329 + - *333 responses: '200': description: Response @@ -89372,9 +89878,9 @@ paths: application/json: schema: type: array - items: *330 + items: *334 examples: - default: *331 + default: *335 '400': *14 '422': *15 x-github: @@ -89393,18 +89899,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: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 - *16 responses: '200': description: Response content: application/json: - schema: *332 + schema: *336 examples: - default: *333 + default: *337 '400': *14 '422': *15 x-github: @@ -89423,9 +89929,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: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 - *16 responses: '202': *37 @@ -89448,9 +89954,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 responses: '204': description: Response @@ -89475,9 +89981,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 responses: '204': description: Response @@ -89500,8 +90006,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response if immutable releases are enabled @@ -89549,8 +90055,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': *144 '409': *112 @@ -89570,8 +90076,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': *144 '409': *112 @@ -89628,14 +90134,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: &628 + schema: &629 title: Import description: A repository import from an external source. type: object @@ -89742,7 +90248,7 @@ paths: - html_url - authors_url examples: - default: &631 + default: &632 value: vcs: subversion use_lfs: true @@ -89758,7 +90264,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': &629 + '503': &630 description: Unavailable due to service under maintenance. content: application/json: @@ -89787,8 +90293,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -89836,7 +90342,7 @@ paths: description: Response content: application/json: - schema: *628 + schema: *629 examples: default: value: @@ -89861,7 +90367,7 @@ paths: type: string '422': *15 '404': *6 - '503': *629 + '503': *630 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89889,8 +90395,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: false content: @@ -89942,7 +90448,7 @@ paths: description: Response content: application/json: - schema: *628 + schema: *629 examples: example-1: summary: Example 1 @@ -89990,7 +90496,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': *629 + '503': *630 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90013,12 +90519,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response - '503': *629 + '503': *630 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90044,9 +90550,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *448 - - *449 - - &814 + - *451 + - *452 + - &816 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -90060,7 +90566,7 @@ paths: application/json: schema: type: array - items: &630 + items: &631 title: Porter Author description: Porter Author type: object @@ -90114,7 +90620,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': *629 + '503': *630 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90139,8 +90645,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *448 - - *449 + - *451 + - *452 - name: author_id in: path required: true @@ -90170,7 +90676,7 @@ paths: description: Response content: application/json: - schema: *630 + schema: *631 examples: default: value: @@ -90183,7 +90689,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *629 + '503': *630 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90207,8 +90713,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -90249,7 +90755,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *629 + '503': *630 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90277,8 +90783,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -90305,11 +90811,11 @@ paths: description: Response content: application/json: - schema: *628 + schema: *629 examples: - default: *631 + default: *632 '422': *15 - '503': *629 + '503': *630 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90332,8 +90838,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -90341,8 +90847,8 @@ paths: application/json: schema: *20 examples: - default: *632 - '301': *462 + default: *633 + '301': *463 '404': *6 x-github: githubCloudOnly: false @@ -90362,8 +90868,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -90371,12 +90877,12 @@ paths: application/json: schema: anyOf: - - *346 + - *350 - type: object properties: {} additionalProperties: false examples: - default: &634 + default: &635 value: limit: collaborators_only origin: repository @@ -90401,13 +90907,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: application/json: - schema: *633 + schema: *634 examples: default: summary: Example request body @@ -90419,9 +90925,9 @@ paths: description: Response content: application/json: - schema: *346 + schema: *350 examples: - default: *634 + default: *635 '409': description: Response x-github: @@ -90443,8 +90949,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -90467,8 +90973,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -90478,9 +90984,9 @@ paths: application/json: schema: type: array - items: *635 + items: *636 examples: - default: &807 + default: &809 value: - id: 1 repository: @@ -90611,9 +91117,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *448 - - *449 - - *350 + - *451 + - *452 + - *354 requestBody: required: false content: @@ -90642,7 +91148,7 @@ paths: description: Response content: application/json: - schema: *635 + schema: *636 examples: default: value: @@ -90773,9 +91279,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *448 - - *449 - - *350 + - *451 + - *452 + - *354 responses: '204': description: Response @@ -90806,8 +91312,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *448 - - *449 + - *451 + - *452 - 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 @@ -90855,7 +91361,7 @@ paths: required: false schema: type: string - - *354 + - *358 - name: sort description: What to sort results by. in: query @@ -90868,7 +91374,7 @@ paths: - comments default: created - *104 - - *208 + - *209 - *17 - *19 responses: @@ -90878,9 +91384,9 @@ paths: application/json: schema: type: array - items: *218 + items: *219 examples: - default: &642 + default: &644 value: - id: 1 node_id: MDU6SXNzdWUx @@ -91028,7 +91534,7 @@ paths: state_reason: completed headers: Link: *41 - '301': *462 + '301': *463 '422': *15 '404': *6 x-github: @@ -91057,8 +91563,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -91148,9 +91654,9 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: &639 + default: &641 value: id: 1 node_id: MDU6SXNzdWUx @@ -91306,7 +91812,7 @@ paths: '422': *15 '503': *184 '404': *6 - '410': *459 + '410': *637 x-github: triggersNotification: true githubCloudOnly: false @@ -91334,9 +91840,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *448 - - *449 - - *227 + - *451 + - *452 + - *228 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -91346,7 +91852,7 @@ paths: enum: - asc - desc - - *208 + - *209 - *17 - *19 responses: @@ -91356,9 +91862,9 @@ paths: application/json: schema: type: array - items: *636 + items: *638 examples: - default: &641 + default: &643 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -91416,17 +91922,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 responses: '200': description: Response content: application/json: - schema: *636 + schema: *638 examples: - default: &637 + default: &639 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -91480,9 +91986,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 requestBody: required: true content: @@ -91504,9 +92010,9 @@ paths: description: Response content: application/json: - schema: *636 + schema: *638 examples: - default: *637 + default: *639 '422': *15 x-github: githubCloudOnly: false @@ -91524,9 +92030,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 responses: '204': description: Response @@ -91546,9 +92052,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 - 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. @@ -91574,9 +92080,9 @@ paths: application/json: schema: type: array - items: *437 + items: *440 examples: - default: *439 + default: *442 headers: Link: *41 '404': *6 @@ -91597,9 +92103,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 requestBody: required: true content: @@ -91631,16 +92137,16 @@ paths: description: Reaction exists content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '201': description: Reaction created content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '422': *15 x-github: githubCloudOnly: false @@ -91662,10 +92168,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *448 - - *449 - - *217 - - *440 + - *451 + - *452 + - *218 + - *443 responses: '204': description: Response @@ -91685,8 +92191,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -91696,7 +92202,7 @@ paths: application/json: schema: type: array - items: &638 + items: &640 title: Issue Event description: Issue Event type: object @@ -91743,7 +92249,7 @@ paths: issue: anyOf: - type: 'null' - - *218 + - *219 label: title: Issue Event Label description: Issue Event Label @@ -91776,7 +92282,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *296 + requested_team: *300 dismissed_review: title: Issue Event Dismissed Review type: object @@ -91843,7 +92349,7 @@ paths: required: - from - to - author_association: *205 + author_association: *206 lock_reason: type: - string @@ -92035,8 +92541,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *448 - - *449 + - *451 + - *452 - name: event_id in: path required: true @@ -92047,7 +92553,7 @@ paths: description: Response content: application/json: - schema: *638 + schema: *640 examples: default: value: @@ -92240,7 +92746,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *459 + '410': *637 '403': *27 x-github: githubCloudOnly: false @@ -92274,9 +92780,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *448 - - *449 - - &640 + - *451 + - *452 + - &642 name: issue_number description: The number that identifies the issue. in: path @@ -92288,12 +92794,12 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 - '301': *462 + default: *641 + '301': *463 '404': *6 - '410': *459 + '410': *637 '304': *35 x-github: githubCloudOnly: false @@ -92318,9 +92824,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: false content: @@ -92439,15 +92945,15 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 + default: *641 '422': *15 '503': *184 '403': *27 - '301': *462 + '301': *463 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92465,9 +92971,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: false content: @@ -92493,9 +92999,9 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 + default: *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92511,9 +93017,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: content: application/json: @@ -92538,9 +93044,9 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 + default: *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92562,9 +93068,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: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - name: assignee in: path required: true @@ -92604,10 +93110,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *448 - - *449 - - *640 - - *208 + - *451 + - *452 + - *642 + - *209 - *17 - *19 responses: @@ -92617,13 +93123,13 @@ paths: application/json: schema: type: array - items: *636 + items: *638 examples: - default: *641 + default: *643 headers: Link: *41 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92652,9 +93158,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: true content: @@ -92676,16 +93182,16 @@ paths: description: Response content: application/json: - schema: *636 + schema: *638 examples: - default: *637 + default: *639 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *459 + '410': *637 '422': *15 '404': *6 x-github: @@ -92713,9 +93219,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: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - *17 - *19 responses: @@ -92725,14 +93231,14 @@ paths: application/json: schema: type: array - items: *218 + items: *219 examples: - default: *642 + default: *644 headers: Link: *41 - '301': *462 + '301': *463 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92760,9 +93266,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: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: true content: @@ -92784,17 +93290,17 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 + default: *641 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *462 + '301': *463 '403': *27 - '410': *459 + '410': *637 '422': *15 '404': *6 x-github: @@ -92825,9 +93331,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: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -92839,15 +93345,15 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 - '301': *462 + default: *641 + '301': *463 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *459 + '410': *637 x-github: triggersNotification: true githubCloudOnly: false @@ -92873,9 +93379,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: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - *17 - *19 responses: @@ -92885,14 +93391,14 @@ paths: application/json: schema: type: array - items: *218 + items: *219 examples: - default: *642 + default: *644 headers: Link: *41 - '301': *462 + '301': *463 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92909,9 +93415,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - *17 - *19 responses: @@ -92925,7 +93431,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &645 + - &647 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -92974,7 +93480,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &646 + - &648 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -93102,7 +93608,7 @@ paths: - performed_via_github_app - assignee - assigner - - &647 + - &649 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -93148,7 +93654,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &648 + - &650 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -93194,7 +93700,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &649 + - &651 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -93243,7 +93749,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &650 + - &652 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -93272,7 +93778,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *296 + requested_team: *300 requested_reviewer: *4 required: - review_requester @@ -93285,7 +93791,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &651 + - &653 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -93314,7 +93820,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *296 + requested_team: *300 requested_reviewer: *4 required: - review_requester @@ -93327,7 +93833,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &652 + - &654 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -93383,7 +93889,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &653 + - &655 title: Locked Issue Event description: Locked Issue Event type: object @@ -93428,7 +93934,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &654 + - &656 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -93489,7 +93995,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &655 + - &657 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -93550,7 +94056,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &656 + - &658 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -93611,7 +94117,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &657 + - &659 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -93704,7 +94210,7 @@ paths: color: red headers: Link: *41 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93721,9 +94227,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - *17 - *19 responses: @@ -93733,7 +94239,7 @@ paths: application/json: schema: type: array - items: &643 + items: &645 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -93788,7 +94294,7 @@ paths: - color - default examples: - default: &644 + default: &646 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -93806,9 +94312,9 @@ paths: default: false headers: Link: *41 - '301': *462 + '301': *463 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93825,9 +94331,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: false content: @@ -93886,12 +94392,12 @@ paths: application/json: schema: type: array - items: *643 + items: *645 examples: - default: *644 - '301': *462 + default: *646 + '301': *463 '404': *6 - '410': *459 + '410': *637 '422': *15 x-github: githubCloudOnly: false @@ -93908,9 +94414,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: false content: @@ -93970,12 +94476,12 @@ paths: application/json: schema: type: array - items: *643 + items: *645 examples: - default: *644 - '301': *462 + default: *646 + '301': *463 '404': *6 - '410': *459 + '410': *637 '422': *15 x-github: githubCloudOnly: false @@ -93992,15 +94498,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 responses: '204': description: Response - '301': *462 + '301': *463 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94019,9 +94525,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - name: name in: path required: true @@ -94034,7 +94540,7 @@ paths: application/json: schema: type: array - items: *643 + items: *645 examples: default: value: @@ -94045,9 +94551,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *462 + '301': *463 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94067,9 +94573,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: false content: @@ -94098,7 +94604,7 @@ paths: '204': description: Response '403': *27 - '410': *459 + '410': *637 '404': *6 '422': *15 x-github: @@ -94116,9 +94622,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 responses: '204': description: Response @@ -94148,20 +94654,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 responses: '200': description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 - '301': *462 + default: *641 + '301': *463 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94178,9 +94684,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - 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. @@ -94206,13 +94712,13 @@ paths: application/json: schema: type: array - items: *437 + items: *440 examples: - default: *439 + default: *442 headers: Link: *41 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94230,9 +94736,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: true content: @@ -94264,16 +94770,16 @@ paths: description: Response content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '201': description: Response content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '422': *15 x-github: githubCloudOnly: false @@ -94295,10 +94801,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *448 - - *449 - - *640 - - *440 + - *451 + - *452 + - *642 + - *443 responses: '204': description: Response @@ -94327,9 +94833,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: true content: @@ -94351,9 +94857,9 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 + default: *641 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -94386,9 +94892,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - *17 - *19 responses: @@ -94398,13 +94904,13 @@ paths: application/json: schema: type: array - items: *218 + items: *219 examples: - default: *642 + default: *644 headers: Link: *41 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94432,9 +94938,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: true content: @@ -94461,16 +94967,16 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 + default: *641 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *459 + '410': *637 '422': *15 '404': *6 x-github: @@ -94490,9 +94996,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: true content: @@ -94523,9 +95029,9 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 + default: *641 '403': *27 '404': *6 '422': *7 @@ -94547,9 +95053,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - *17 - *19 responses: @@ -94564,8 +95070,6 @@ paths: description: Timeline Event type: object anyOf: - - *645 - - *646 - *647 - *648 - *649 @@ -94577,6 +95081,8 @@ paths: - *655 - *656 - *657 + - *658 + - *659 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -94624,12 +95130,12 @@ paths: issue_url: type: string format: uri - author_association: *205 + author_association: *206 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *206 + reactions: *207 required: - event - actor @@ -94660,7 +95166,7 @@ paths: properties: type: type: string - issue: *218 + issue: *219 required: - event - created_at @@ -94882,7 +95388,7 @@ paths: type: string body_text: type: string - author_association: *205 + author_association: *206 required: - event - id @@ -94905,7 +95411,7 @@ paths: type: string comments: type: array - items: &678 + items: &680 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -95010,7 +95516,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *205 + author_association: *206 _links: type: object properties: @@ -95105,7 +95611,7 @@ paths: enum: - line - file - reactions: *206 + reactions: *207 body_html: type: string examples: @@ -95143,7 +95649,7 @@ paths: type: string comments: type: array - items: *563 + items: *564 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -95418,7 +95924,7 @@ paths: headers: Link: *41 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95435,8 +95941,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -95446,7 +95952,7 @@ paths: application/json: schema: type: array - items: &658 + items: &660 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -95514,8 +96020,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -95551,9 +96057,9 @@ paths: description: Response content: application/json: - schema: *658 + schema: *660 examples: - default: &659 + default: &661 value: id: 1 key: ssh-rsa AAA... @@ -95587,9 +96093,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *448 - - *449 - - &660 + - *451 + - *452 + - &662 name: key_id description: The unique identifier of the key. in: path @@ -95601,9 +96107,9 @@ paths: description: Response content: application/json: - schema: *658 + schema: *660 examples: - default: *659 + default: *661 '404': *6 x-github: githubCloudOnly: false @@ -95621,9 +96127,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *448 - - *449 - - *660 + - *451 + - *452 + - *662 responses: '204': description: Response @@ -95643,8 +96149,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -95654,9 +96160,9 @@ paths: application/json: schema: type: array - items: *643 + items: *645 examples: - default: *644 + default: *646 headers: Link: *41 '404': *6 @@ -95677,8 +96183,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -95714,9 +96220,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *645 examples: - default: &661 + default: &663 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -95748,8 +96254,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *448 - - *449 + - *451 + - *452 - name: name in: path required: true @@ -95760,9 +96266,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *645 examples: - default: *661 + default: *663 '404': *6 x-github: githubCloudOnly: false @@ -95779,8 +96285,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *448 - - *449 + - *451 + - *452 - name: name in: path required: true @@ -95819,7 +96325,7 @@ paths: description: Response content: application/json: - schema: *643 + schema: *645 examples: default: value: @@ -95845,8 +96351,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *448 - - *449 + - *451 + - *452 - name: name in: path required: true @@ -95872,8 +96378,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -95909,8 +96415,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '202': *37 '403': @@ -95938,8 +96444,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -95965,9 +96471,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *448 - - *449 - - *541 + - *451 + - *452 + - *542 responses: '200': description: Response @@ -96033,7 +96539,7 @@ paths: license: anyOf: - type: 'null' - - *219 + - *220 required: - _links - git_url @@ -96114,8 +96620,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -96180,8 +96686,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -96215,9 +96721,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *564 + schema: *565 examples: - default: *662 + default: *664 '204': description: Response when already merged '404': @@ -96242,8 +96748,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *448 - - *449 + - *451 + - *452 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -96284,7 +96790,7 @@ paths: application/json: schema: type: array - items: *387 + items: *390 examples: default: value: @@ -96340,8 +96846,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -96381,9 +96887,9 @@ paths: description: Response content: application/json: - schema: *387 + schema: *390 examples: - default: &663 + default: &665 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -96442,9 +96948,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *448 - - *449 - - &664 + - *451 + - *452 + - &666 name: milestone_number description: The number that identifies the milestone. in: path @@ -96456,9 +96962,9 @@ paths: description: Response content: application/json: - schema: *387 + schema: *390 examples: - default: *663 + default: *665 '404': *6 x-github: githubCloudOnly: false @@ -96475,9 +96981,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *448 - - *449 - - *664 + - *451 + - *452 + - *666 requestBody: required: false content: @@ -96515,9 +97021,9 @@ paths: description: Response content: application/json: - schema: *387 + schema: *390 examples: - default: *663 + default: *665 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96533,9 +97039,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *448 - - *449 - - *664 + - *451 + - *452 + - *666 responses: '204': description: Response @@ -96556,9 +97062,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: - - *448 - - *449 - - *664 + - *451 + - *452 + - *666 - *17 - *19 responses: @@ -96568,9 +97074,9 @@ paths: application/json: schema: type: array - items: *643 + items: *645 examples: - default: *644 + default: *646 headers: Link: *41 x-github: @@ -96589,12 +97095,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: - - *448 - - *449 - - *665 - - *666 - - *208 + - *451 + - *452 - *667 + - *668 + - *209 + - *669 - *17 - *19 responses: @@ -96604,9 +97110,9 @@ paths: application/json: schema: type: array - items: *230 + items: *231 examples: - default: *668 + default: *670 headers: Link: *41 x-github: @@ -96630,8 +97136,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: false content: @@ -96689,14 +97195,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: &669 + schema: &671 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -96840,7 +97346,7 @@ paths: - custom_404 - public examples: - default: &670 + default: &672 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -96881,8 +97387,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -96937,9 +97443,9 @@ paths: description: Response content: application/json: - schema: *669 + schema: *671 examples: - default: *670 + default: *672 '422': *15 '409': *112 x-github: @@ -96962,8 +97468,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -97071,8 +97577,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -97098,8 +97604,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -97109,7 +97615,7 @@ paths: application/json: schema: type: array - items: &671 + items: &673 title: Page Build description: Page Build type: object @@ -97201,8 +97707,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *448 - - *449 + - *451 + - *452 responses: '201': description: Response @@ -97249,16 +97755,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *671 + schema: *673 examples: - default: &672 + default: &674 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -97306,8 +97812,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *448 - - *449 + - *451 + - *452 - name: build_id in: path required: true @@ -97318,9 +97824,9 @@ paths: description: Response content: application/json: - schema: *671 + schema: *673 examples: - default: *672 + default: *674 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97340,8 +97846,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -97449,9 +97955,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: - - *448 - - *449 - - &673 + - *451 + - *452 + - &675 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -97509,9 +98015,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *448 - - *449 - - *673 + - *451 + - *452 + - *675 responses: '204': *144 '404': *6 @@ -97538,8 +98044,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -97807,7 +98313,7 @@ paths: description: Empty response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -97834,8 +98340,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Private vulnerability reporting status @@ -97872,8 +98378,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': *144 '422': *14 @@ -97894,8 +98400,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': *144 '422': *14 @@ -97904,148 +98410,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repos/{owner}/{repo}/projects": - get: - summary: List repository 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: - - projects-classic - operationId: projects-classic/list-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-repository-projects - parameters: - - *448 - - *449 - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *382 - examples: - default: - value: - - owner_url: https://api.github.com/repos/api-playground/projects-test - url: https://api.github.com/projects/1002604 - html_url: https://github.com/api-playground/projects-test/projects/1 - columns_url: https://api.github.com/projects/1002604/columns - id: 1002604 - node_id: MDc6UHJvamVjdDEwMDI2MDQ= - name: Projects Documentation - body: Developer documentation project for the developer site. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - headers: - Link: *41 - '401': *23 - '403': *27 - '404': *6 - '410': *459 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create a repository 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: - - projects-classic - operationId: projects-classic/create-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-a-repository-project - parameters: - - *448 - - *449 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the project. - body: - type: string - description: The description of the project. - required: - - name - examples: - default: - value: - name: Projects Documentation - body: Developer documentation project for the developer site. - responses: - '201': - description: Response - content: - application/json: - schema: *382 - examples: - default: *458 - '401': *23 - '403': *27 - '404': *6 - '410': *459 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/repos/{owner}/{repo}/properties/values": get: summary: Get all custom property values for a repository @@ -98059,8 +98423,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -98070,7 +98434,7 @@ paths: type: array items: *145 examples: - default: *674 + default: *676 '403': *27 '404': *6 x-github: @@ -98092,8 +98456,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -98109,7 +98473,7 @@ paths: required: - properties examples: - default: *675 + default: *677 responses: '204': description: No Content when custom property values are successfully created @@ -98147,8 +98511,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *448 - - *449 + - *451 + - *452 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -98208,9 +98572,9 @@ paths: application/json: schema: type: array - items: *568 + items: *569 examples: - default: *676 + default: *678 headers: Link: *41 '304': *35 @@ -98242,8 +98606,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -98310,7 +98674,7 @@ paths: description: Response content: application/json: - schema: &680 + schema: &682 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -98439,7 +98803,7 @@ paths: milestone: anyOf: - type: 'null' - - *387 + - *390 active_lock_reason: type: - string @@ -98494,7 +98858,7 @@ paths: type: - array - 'null' - items: *364 + items: *368 head: type: object properties: @@ -98532,14 +98896,14 @@ paths: _links: type: object properties: - comments: *388 - commits: *388 - statuses: *388 - html: *388 - issue: *388 - review_comments: *388 - review_comment: *388 - self: *388 + comments: *391 + commits: *391 + statuses: *391 + html: *391 + issue: *391 + review_comments: *391 + review_comment: *391 + self: *391 required: - comments - commits @@ -98549,8 +98913,8 @@ paths: - review_comments - review_comment - self - author_association: *205 - auto_merge: *677 + author_association: *206 + auto_merge: *679 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -98652,7 +99016,7 @@ paths: - merged_by - review_comments examples: - default: &681 + default: &683 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -99179,8 +99543,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *448 - - *449 + - *451 + - *452 - name: sort in: query required: false @@ -99199,7 +99563,7 @@ paths: enum: - asc - desc - - *208 + - *209 - *17 - *19 responses: @@ -99209,9 +99573,9 @@ paths: application/json: schema: type: array - items: *678 + items: *680 examples: - default: &683 + default: &685 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -99288,17 +99652,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: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 responses: '200': description: Response content: application/json: - schema: *678 + schema: *680 examples: - default: &679 + default: &681 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -99373,9 +99737,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: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 requestBody: required: true content: @@ -99397,9 +99761,9 @@ paths: description: Response content: application/json: - schema: *678 + schema: *680 examples: - default: *679 + default: *681 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99415,9 +99779,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: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 responses: '204': description: Response @@ -99438,9 +99802,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: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 - 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. @@ -99466,9 +99830,9 @@ paths: application/json: schema: type: array - items: *437 + items: *440 examples: - default: *439 + default: *442 headers: Link: *41 '404': *6 @@ -99489,9 +99853,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: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 requestBody: required: true content: @@ -99523,16 +99887,16 @@ paths: description: Reaction exists content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '201': description: Reaction created content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '422': *15 x-github: githubCloudOnly: false @@ -99554,10 +99918,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *448 - - *449 - - *217 - - *440 + - *451 + - *452 + - *218 + - *443 responses: '204': description: Response @@ -99600,9 +99964,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *448 - - *449 - - &682 + - *451 + - *452 + - &684 name: pull_number description: The number that identifies the pull request. in: path @@ -99615,9 +99979,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *680 + schema: *682 examples: - default: *681 + default: *683 '304': *35 '404': *6 '406': @@ -99652,9 +100016,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 requestBody: required: false content: @@ -99696,9 +100060,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *682 examples: - default: *681 + default: *683 '422': *15 '403': *27 x-github: @@ -99720,9 +100084,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: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 requestBody: required: true content: @@ -99783,17 +100147,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '401': *23 '403': *27 '404': *6 @@ -99823,10 +100187,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: - - *448 - - *449 - - *682 - - *227 + - *451 + - *452 + - *684 + - *228 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -99836,7 +100200,7 @@ paths: enum: - asc - desc - - *208 + - *209 - *17 - *19 responses: @@ -99846,9 +100210,9 @@ paths: application/json: schema: type: array - items: *678 + items: *680 examples: - default: *683 + default: *685 headers: Link: *41 x-github: @@ -99881,9 +100245,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: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 requestBody: required: true content: @@ -99989,7 +100353,7 @@ paths: description: Response content: application/json: - schema: *678 + schema: *680 examples: example-for-a-multi-line-comment: value: @@ -100077,10 +100441,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: - - *448 - - *449 - - *682 - - *217 + - *451 + - *452 + - *684 + - *218 requestBody: required: true content: @@ -100102,7 +100466,7 @@ paths: description: Response content: application/json: - schema: *678 + schema: *680 examples: default: value: @@ -100188,9 +100552,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 - *17 - *19 responses: @@ -100200,9 +100564,9 @@ paths: application/json: schema: type: array - items: *564 + items: *565 examples: - default: *684 + default: *686 headers: Link: *41 x-github: @@ -100232,9 +100596,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 - *17 - *19 responses: @@ -100244,7 +100608,7 @@ paths: application/json: schema: type: array - items: *575 + items: *576 examples: default: value: @@ -100282,9 +100646,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: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 responses: '204': description: Response if pull request has been merged @@ -100307,9 +100671,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 requestBody: required: false content: @@ -100421,9 +100785,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: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 responses: '200': description: Response @@ -100439,7 +100803,7 @@ paths: items: *4 teams: type: array - items: *296 + items: *300 required: - users - teams @@ -100498,9 +100862,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: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 requestBody: required: false content: @@ -100537,7 +100901,7 @@ paths: description: Response content: application/json: - schema: *568 + schema: *569 examples: default: value: @@ -101073,9 +101437,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: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 requestBody: required: true content: @@ -101109,7 +101473,7 @@ paths: description: Response content: application/json: - schema: *568 + schema: *569 examples: default: value: @@ -101614,9 +101978,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 - *17 - *19 responses: @@ -101626,7 +101990,7 @@ paths: application/json: schema: type: array - items: &685 + items: &687 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -101700,7 +102064,7 @@ paths: type: string body_text: type: string - author_association: *205 + author_association: *206 required: - id - node_id @@ -101782,9 +102146,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: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 requestBody: required: false content: @@ -101874,9 +102238,9 @@ paths: description: Response content: application/json: - schema: *685 + schema: *687 examples: - default: &687 + default: &689 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -101939,10 +102303,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: - - *448 - - *449 - - *682 - - &686 + - *451 + - *452 + - *684 + - &688 name: review_id description: The unique identifier of the review. in: path @@ -101954,9 +102318,9 @@ paths: description: Response content: application/json: - schema: *685 + schema: *687 examples: - default: &688 + default: &690 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -102015,10 +102379,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: - - *448 - - *449 - - *682 - - *686 + - *451 + - *452 + - *684 + - *688 requestBody: required: true content: @@ -102041,7 +102405,7 @@ paths: description: Response content: application/json: - schema: *685 + schema: *687 examples: default: value: @@ -102103,18 +102467,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: - - *448 - - *449 - - *682 - - *686 + - *451 + - *452 + - *684 + - *688 responses: '200': description: Response content: application/json: - schema: *685 + schema: *687 examples: - default: *687 + default: *689 '422': *7 '404': *6 x-github: @@ -102141,10 +102505,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: - - *448 - - *449 - - *682 - - *686 + - *451 + - *452 + - *684 + - *688 - *17 - *19 responses: @@ -102238,13 +102602,13 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *205 + author_association: *206 _links: type: object properties: - self: *388 - html: *388 - pull_request: *388 + self: *391 + html: *391 + pull_request: *391 required: - self - html @@ -102253,7 +102617,7 @@ paths: type: string body_html: type: string - reactions: *206 + reactions: *207 side: description: The side of the first line of the range for a multi-line comment. @@ -102402,10 +102766,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: - - *448 - - *449 - - *682 - - *686 + - *451 + - *452 + - *684 + - *688 requestBody: required: true content: @@ -102434,7 +102798,7 @@ paths: description: Response content: application/json: - schema: *685 + schema: *687 examples: default: value: @@ -102497,10 +102861,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: - - *448 - - *449 - - *682 - - *686 + - *451 + - *452 + - *684 + - *688 requestBody: required: true content: @@ -102535,9 +102899,9 @@ paths: description: Response content: application/json: - schema: *685 + schema: *687 examples: - default: *688 + default: *690 '404': *6 '422': *7 '403': *27 @@ -102559,9 +102923,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 requestBody: required: false content: @@ -102625,8 +102989,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *448 - - *449 + - *451 + - *452 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -102639,9 +103003,9 @@ paths: description: Response content: application/json: - schema: *689 + schema: *691 examples: - default: &690 + default: &692 value: type: file encoding: base64 @@ -102683,8 +103047,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: - - *448 - - *449 + - *451 + - *452 - name: dir description: The alternate path to look for a README file in: path @@ -102704,9 +103068,9 @@ paths: description: Response content: application/json: - schema: *689 + schema: *691 examples: - default: *690 + default: *692 '404': *6 '422': *15 x-github: @@ -102728,8 +103092,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -102739,7 +103103,7 @@ paths: application/json: schema: type: array - items: &691 + items: &693 title: Release description: A release. type: object @@ -102821,7 +103185,7 @@ paths: author: *4 assets: type: array - items: &692 + items: &694 title: Release Asset description: Data related to a release. type: object @@ -102896,7 +103260,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *206 + reactions: *207 required: - assets_url - upload_url @@ -103008,8 +103372,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -103085,9 +103449,9 @@ paths: description: Response content: application/json: - schema: *691 + schema: *693 examples: - default: &695 + default: &697 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -103192,9 +103556,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *448 - - *449 - - &693 + - *451 + - *452 + - &695 name: asset_id description: The unique identifier of the asset. in: path @@ -103206,9 +103570,9 @@ paths: description: Response content: application/json: - schema: *692 + schema: *694 examples: - default: &694 + default: &696 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 @@ -103243,7 +103607,7 @@ paths: type: User site_admin: false '404': *6 - '302': *577 + '302': *578 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103259,9 +103623,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *448 - - *449 - - *693 + - *451 + - *452 + - *695 requestBody: required: false content: @@ -103290,9 +103654,9 @@ paths: description: Response content: application/json: - schema: *692 + schema: *694 examples: - default: *694 + default: *696 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103308,9 +103672,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *448 - - *449 - - *693 + - *451 + - *452 + - *695 responses: '204': description: Response @@ -103334,8 +103698,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -103421,16 +103785,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *691 + schema: *693 examples: - default: *695 + default: *697 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103447,8 +103811,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *448 - - *449 + - *451 + - *452 - name: tag description: tag parameter in: path @@ -103461,9 +103825,9 @@ paths: description: Response content: application/json: - schema: *691 + schema: *693 examples: - default: *695 + default: *697 '404': *6 x-github: githubCloudOnly: false @@ -103485,9 +103849,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *448 - - *449 - - &696 + - *451 + - *452 + - &698 name: release_id description: The unique identifier of the release. in: path @@ -103501,9 +103865,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: *691 + schema: *693 examples: - default: *695 + default: *697 '401': description: Unauthorized x-github: @@ -103521,9 +103885,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *448 - - *449 - - *696 + - *451 + - *452 + - *698 requestBody: required: false content: @@ -103587,9 +103951,9 @@ paths: description: Response content: application/json: - schema: *691 + schema: *693 examples: - default: *695 + default: *697 '404': description: Not Found if the discussion category name is invalid content: @@ -103610,9 +103974,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *448 - - *449 - - *696 + - *451 + - *452 + - *698 responses: '204': description: Response @@ -103632,9 +103996,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *448 - - *449 - - *696 + - *451 + - *452 + - *698 - *17 - *19 responses: @@ -103644,7 +104008,7 @@ paths: application/json: schema: type: array - items: *692 + items: *694 examples: default: value: @@ -103726,9 +104090,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: - - *448 - - *449 - - *696 + - *451 + - *452 + - *698 - name: name in: query required: true @@ -103754,7 +104118,7 @@ paths: description: Response for successful upload content: application/json: - schema: *692 + schema: *694 examples: response-for-successful-upload: value: @@ -103809,9 +104173,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *448 - - *449 - - *696 + - *451 + - *452 + - *698 - 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. @@ -103835,9 +104199,9 @@ paths: application/json: schema: type: array - items: *437 + items: *440 examples: - default: *439 + default: *442 headers: Link: *41 '404': *6 @@ -103858,9 +104222,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *448 - - *449 - - *696 + - *451 + - *452 + - *698 requestBody: required: true content: @@ -103890,16 +104254,16 @@ paths: description: Reaction exists content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '201': description: Reaction created content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '422': *15 x-github: githubCloudOnly: false @@ -103921,10 +104285,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *448 - - *449 - - *696 - - *440 + - *451 + - *452 + - *698 + - *443 responses: '204': description: Response @@ -103948,9 +104312,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 - *17 - *19 responses: @@ -103967,7 +104331,7 @@ paths: oneOf: - allOf: - *159 - - &697 + - &699 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -103988,67 +104352,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *160 - - *697 + - *699 - allOf: - *161 - - *697 + - *699 - allOf: - *162 - - *697 + - *699 - allOf: - - *698 - - *697 + - *700 + - *699 - allOf: - *163 - - *697 + - *699 - allOf: - *164 - - *697 + - *699 - allOf: - *165 - - *697 + - *699 - allOf: - *166 - - *697 + - *699 - allOf: - *167 - - *697 + - *699 - allOf: - *168 - - *697 + - *699 - allOf: - *169 - - *697 + - *699 - allOf: - *170 - - *697 + - *699 - allOf: - *171 - - *697 + - *699 - allOf: - *172 - - *697 + - *699 - allOf: - *173 - - *697 + - *699 - allOf: - *174 - - *697 + - *699 - allOf: - *175 - - *697 + - *699 - allOf: - *176 - - *697 + - *699 - allOf: - *177 - - *697 + - *699 - allOf: - *178 - - *697 + - *699 - allOf: + - *701 - *699 - - *697 examples: default: value: @@ -104087,8 +104451,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 - name: includes_parents @@ -104099,7 +104463,7 @@ paths: schema: type: boolean default: true - - *700 + - *702 responses: '200': description: Response @@ -104154,8 +104518,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *451 + - *452 requestBody: description: Request body required: true @@ -104184,7 +104548,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *701 + items: *703 required: - name - enforcement @@ -104217,7 +104581,7 @@ paths: application/json: schema: *179 examples: - default: &710 + default: &712 value: id: 42 name: super cool ruleset @@ -104264,12 +104628,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *448 - - *449 - - *702 - - *99 - - *703 + - *451 + - *452 - *704 + - *99 + - *705 + - *706 - *17 - *19 responses: @@ -104277,9 +104641,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *707 examples: - default: *706 + default: *708 '404': *6 '500': *38 x-github: @@ -104300,17 +104664,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *448 - - *449 - - *707 + - *451 + - *452 + - *709 responses: '200': description: Response content: application/json: - schema: *708 + schema: *710 examples: - default: *709 + default: *711 '404': *6 '500': *38 x-github: @@ -104338,8 +104702,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *451 + - *452 - name: ruleset_id description: The ID of the ruleset. in: path @@ -104361,7 +104725,7 @@ paths: application/json: schema: *179 examples: - default: *710 + default: *712 '404': *6 '500': *38 put: @@ -104379,8 +104743,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *451 + - *452 - name: ruleset_id description: The ID of the ruleset. in: path @@ -104414,7 +104778,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *701 + items: *703 examples: default: value: @@ -104444,7 +104808,7 @@ paths: application/json: schema: *179 examples: - default: *710 + default: *712 '404': *6 '500': *38 delete: @@ -104462,8 +104826,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *451 + - *452 - name: ruleset_id description: The ID of the ruleset. in: path @@ -104486,8 +104850,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 - name: ruleset_id @@ -104505,7 +104869,7 @@ paths: type: array items: *183 examples: - default: *401 + default: *404 '404': *6 '500': *38 x-github: @@ -104524,8 +104888,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *448 - - *449 + - *451 + - *452 - name: ruleset_id description: The ID of the ruleset. in: path @@ -104543,7 +104907,7 @@ paths: description: Response content: application/json: - schema: *402 + schema: *405 examples: default: value: @@ -104598,21 +104962,21 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *448 - - *449 - - *403 - - *404 - - *405 + - *451 + - *452 - *406 - - *104 - - *19 - - *17 - - *711 - - *712 - *407 - *408 - *409 + - *104 + - *19 + - *17 + - *713 + - *714 - *410 + - *411 + - *412 + - *413 responses: '200': description: Response @@ -104620,7 +104984,7 @@ paths: application/json: schema: type: array - items: &716 + items: &718 type: object properties: number: *119 @@ -104636,8 +105000,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *713 - resolution: *714 + state: *715 + resolution: *716 resolved_at: type: - string @@ -104731,7 +105095,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *715 + - *717 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -104876,16 +105240,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: - - *448 - - *449 - - *535 - - *410 + - *451 + - *452 + - *536 + - *413 responses: '200': description: Response content: application/json: - schema: *716 + schema: *718 examples: default: value: @@ -104937,9 +105301,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: - - *448 - - *449 - - *535 + - *451 + - *452 + - *536 requestBody: required: true content: @@ -104947,16 +105311,17 @@ paths: schema: type: object properties: - state: *713 - resolution: *714 + state: *715 + resolution: *716 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: - string - 'null' - required: - - state + anyOf: + - required: + - state examples: default: value: @@ -104967,7 +105332,7 @@ paths: description: Response content: application/json: - schema: *716 + schema: *718 examples: default: value: @@ -105042,9 +105407,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: - - *448 - - *449 - - *535 + - *451 + - *452 + - *536 - *19 - *17 responses: @@ -105055,7 +105420,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &892 + items: &894 type: object properties: type: @@ -105082,8 +105447,6 @@ paths: - commit details: oneOf: - - *717 - - *718 - *719 - *720 - *721 @@ -105095,6 +105458,8 @@ paths: - *727 - *728 - *729 + - *730 + - *731 examples: default: value: @@ -105180,8 +105545,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -105189,14 +105554,14 @@ paths: schema: type: object properties: - reason: &731 + reason: &733 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *730 + placeholder_id: *732 required: - reason - placeholder_id @@ -105213,7 +105578,7 @@ paths: schema: type: object properties: - reason: *731 + reason: *733 expire_at: type: - string @@ -105260,8 +105625,8 @@ 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: - - *448 - - *449 + - *451 + - *452 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -105276,7 +105641,7 @@ paths: properties: incremental_scans: type: array - items: &732 + items: &734 description: Information on a single scan performed by secret scanning on the repository type: object @@ -105304,15 +105669,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *732 + items: *734 backfill_scans: type: array - items: *732 + items: *734 custom_pattern_backfill_scans: type: array items: allOf: - - *732 + - *734 - type: object properties: pattern_name: @@ -105382,8 +105747,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *448 - - *449 + - *451 + - *452 - *104 - name: sort description: The property to sort the results by. @@ -105427,9 +105792,9 @@ paths: application/json: schema: type: array - items: *733 + items: *735 examples: - default: *734 + default: *736 '400': *14 '404': *6 x-github: @@ -105452,8 +105817,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -105533,7 +105898,7 @@ paths: login: type: string description: The username of the user credited. - type: *415 + type: *418 required: - login - type @@ -105623,9 +105988,9 @@ paths: description: Response content: application/json: - schema: *733 + schema: *735 examples: - default: &736 + default: &738 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -105858,8 +106223,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -105972,7 +106337,7 @@ paths: description: Response content: application/json: - schema: *733 + schema: *735 examples: default: value: @@ -106119,17 +106484,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: - - *448 - - *449 - - *735 + - *451 + - *452 + - *737 responses: '200': description: Response content: application/json: - schema: *733 + schema: *735 examples: - default: *736 + default: *738 '403': *27 '404': *6 x-github: @@ -106153,9 +106518,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: - - *448 - - *449 - - *735 + - *451 + - *452 + - *737 requestBody: required: true content: @@ -106235,7 +106600,7 @@ paths: login: type: string description: The username of the user credited. - type: *415 + type: *418 required: - login - type @@ -106326,17 +106691,17 @@ paths: description: Response content: application/json: - schema: *733 + schema: *735 examples: - default: *736 - add_credit: *736 + default: *738 + add_credit: *738 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *244 + schema: *248 examples: invalid_state_transition: value: @@ -106367,9 +106732,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: - - *448 - - *449 - - *735 + - *451 + - *452 + - *737 responses: '202': *37 '400': *14 @@ -106396,17 +106761,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *448 - - *449 - - *735 + - *451 + - *452 + - *737 responses: '202': description: Response content: application/json: - schema: *461 + schema: *462 examples: - default: *463 + default: *464 '400': *14 '422': *15 '403': *27 @@ -106432,8 +106797,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -106529,8 +106894,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -106539,7 +106904,7 @@ paths: application/json: schema: type: array - items: &737 + items: &739 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -106572,8 +106937,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -106651,8 +107016,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -106746,8 +107111,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -106901,8 +107266,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -106912,7 +107277,7 @@ paths: application/json: schema: type: array - items: *737 + items: *739 examples: default: value: @@ -106945,8 +107310,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *448 - - *449 + - *451 + - *452 - name: sha in: path required: true @@ -107002,7 +107367,7 @@ paths: description: Response content: application/json: - schema: *738 + schema: *740 examples: default: value: @@ -107056,8 +107421,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -107069,7 +107434,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 x-github: @@ -107089,14 +107454,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &739 + schema: &741 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -107169,8 +107534,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: false content: @@ -107196,7 +107561,7 @@ paths: description: Response content: application/json: - schema: *739 + schema: *741 examples: default: value: @@ -107223,8 +107588,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -107244,8 +107609,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -107327,8 +107692,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -107336,7 +107701,7 @@ paths: application/json: schema: type: array - items: &740 + items: &742 title: Tag protection description: Tag protection type: object @@ -107393,8 +107758,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -107417,7 +107782,7 @@ paths: description: Response content: application/json: - schema: *740 + schema: *742 examples: default: value: @@ -107448,8 +107813,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: - - *448 - - *449 + - *451 + - *452 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -107486,8 +107851,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *448 - - *449 + - *451 + - *452 - name: ref in: path required: true @@ -107523,8 +107888,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -107534,9 +107899,9 @@ paths: application/json: schema: type: array - items: *296 + items: *300 examples: - default: *365 + default: *369 headers: Link: *41 '404': *6 @@ -107556,8 +107921,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *448 - - *449 + - *451 + - *452 - *19 - *17 responses: @@ -107565,7 +107930,7 @@ paths: description: Response content: application/json: - schema: &741 + schema: &743 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -107577,7 +107942,7 @@ paths: required: - names examples: - default: &742 + default: &744 value: names: - octocat @@ -107600,8 +107965,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -107632,9 +107997,9 @@ paths: description: Response content: application/json: - schema: *741 + schema: *743 examples: - default: *742 + default: *744 '404': *6 '422': *7 x-github: @@ -107655,9 +108020,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *448 - - *449 - - &743 + - *451 + - *452 + - &745 name: per description: The time frame to display results for. in: query @@ -107688,7 +108053,7 @@ paths: - 128 clones: type: array - items: &744 + items: &746 title: Traffic type: object properties: @@ -107775,8 +108140,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -107870,8 +108235,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -107934,9 +108299,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *448 - - *449 - - *743 + - *451 + - *452 + - *745 responses: '200': description: Response @@ -107957,7 +108322,7 @@ paths: - 3782 views: type: array - items: *744 + items: *746 required: - uniques - count @@ -108034,8 +108399,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -108071,7 +108436,7 @@ paths: description: Response content: application/json: - schema: *269 + schema: *273 examples: default: value: @@ -108309,8 +108674,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: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -108333,8 +108698,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -108356,8 +108721,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -108383,8 +108748,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *448 - - *449 + - *451 + - *452 - name: ref in: path required: true @@ -108476,9 +108841,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *462 examples: - default: *463 + default: *464 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -108519,7 +108884,7 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: default: value: @@ -108629,7 +108994,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &752 + - &754 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -108639,7 +109004,7 @@ paths: type: string examples: - members - - &757 + - &759 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -108651,7 +109016,7 @@ paths: format: int32 examples: - 1 - - &758 + - &760 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -108695,7 +109060,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &747 + items: &749 allOf: - type: object required: @@ -108777,7 +109142,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: &759 + meta: &761 type: object description: The metadata associated with the creation/updates to the user. @@ -108842,30 +109207,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &748 + '400': &750 description: Bad request content: application/json: - schema: *745 + schema: *747 application/scim+json: - schema: *745 - '401': *746 - '403': &749 + schema: *747 + '401': *748 + '403': &751 description: Permission denied - '429': &750 + '429': &752 description: Too many requests content: application/json: - schema: *745 + schema: *747 application/scim+json: - schema: *745 - '500': &751 + schema: *747 + '500': &753 description: Internal server error content: application/json: - schema: *745 + schema: *747 application/scim+json: - schema: *745 + schema: *747 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -108889,7 +109254,7 @@ paths: required: true content: application/json: - schema: &755 + schema: &757 type: object required: - schemas @@ -108953,9 +109318,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *747 + schema: *749 examples: - group: &753 + group: &755 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -108974,13 +109339,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': *748 - '401': *746 - '403': *749 - '409': &756 + '400': *750 + '401': *748 + '403': *751 + '409': &758 description: Duplicate record detected - '429': *750 - '500': *751 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -108997,7 +109362,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: - - &754 + - &756 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -109006,22 +109371,22 @@ paths: type: string examples: - 7fce0092-d52e-4f76-b727-3955bd72c939 - - *752 + - *754 - *39 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *747 + schema: *749 examples: - default: *753 - '400': *748 - '401': *746 - '403': *749 + default: *755 + '400': *750 + '401': *748 + '403': *751 '404': *6 - '429': *750 - '500': *751 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109040,13 +109405,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: - - *754 + - *756 - *39 requestBody: required: true content: application/json: - schema: *755 + schema: *757 examples: group: summary: Group @@ -109072,17 +109437,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *747 + schema: *749 examples: - group: *753 - groupWithMembers: *753 - '400': *748 - '401': *746 - '403': *749 + group: *755 + groupWithMembers: *755 + '400': *750 + '401': *748 + '403': *751 '404': *6 - '409': *756 - '429': *750 - '500': *751 + '409': *758 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109106,13 +109471,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: - - *754 + - *756 - *39 requestBody: required: true content: application/json: - schema: &766 + schema: &768 type: object required: - Operations @@ -109172,17 +109537,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *747 + schema: *749 examples: - updateGroup: *753 - addMembers: *753 - '400': *748 - '401': *746 - '403': *749 + updateGroup: *755 + addMembers: *755 + '400': *750 + '401': *748 + '403': *751 '404': *6 - '409': *756 - '429': *750 - '500': *751 + '409': *758 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109198,17 +109563,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: - - *754 + - *756 - *39 responses: '204': description: Group was deleted, no content - '400': *748 - '401': *746 - '403': *749 + '400': *750 + '401': *748 + '403': *751 '404': *6 - '429': *750 - '500': *751 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109242,8 +109607,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *757 - - *758 + - *759 + - *760 - *39 responses: '200': @@ -109277,7 +109642,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &761 + items: &763 allOf: - type: object required: @@ -109369,7 +109734,7 @@ paths: address. examples: - true - roles: &760 + roles: &762 type: array description: The roles assigned to the user. items: @@ -109428,7 +109793,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *759 + meta: *761 startIndex: type: integer description: A starting index for the returned page @@ -109467,11 +109832,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *748 - '401': *746 - '403': *749 - '429': *750 - '500': *751 + '400': *750 + '401': *748 + '403': *751 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109495,7 +109860,7 @@ paths: required: true content: application/json: - schema: &764 + schema: &766 type: object required: - schemas @@ -109588,9 +109953,9 @@ paths: description: Whether this email address is the primary address. examples: - true - roles: *760 + roles: *762 examples: - user: &765 + user: &767 summary: User value: schemas: @@ -109637,9 +110002,9 @@ paths: description: User has been created content: application/scim+json: - schema: *761 + schema: *763 examples: - user: &762 + user: &764 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -109665,13 +110030,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: *762 - '400': *748 - '401': *746 - '403': *749 - '409': *756 - '429': *750 - '500': *751 + enterpriseOwner: *764 + '400': *750 + '401': *748 + '403': *751 + '409': *758 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109688,7 +110053,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: - - &763 + - &765 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -109701,15 +110066,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *761 + schema: *763 examples: - default: *762 - '400': *748 - '401': *746 - '403': *749 + default: *764 + '400': *750 + '401': *748 + '403': *751 '404': *6 - '429': *750 - '500': *751 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109731,30 +110096,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: - - *763 + - *765 - *39 requestBody: required: true content: application/json: - schema: *764 + schema: *766 examples: - user: *765 + user: *767 responses: '200': description: User was updated content: application/scim+json: - schema: *761 + schema: *763 examples: - user: *762 - '400': *748 - '401': *746 - '403': *749 + user: *764 + '400': *750 + '401': *748 + '403': *751 '404': *6 - '409': *756 - '429': *750 - '500': *751 + '409': *758 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109789,13 +110154,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: - - *763 + - *765 - *39 requestBody: required: true content: application/json: - schema: *766 + schema: *768 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -109835,18 +110200,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *761 + schema: *763 examples: - userMultiValuedProperties: *762 - userSingleValuedProperties: *762 - disableUser: *762 - '400': *748 - '401': *746 - '403': *749 + userMultiValuedProperties: *764 + userSingleValuedProperties: *764 + disableUser: *764 + '400': *750 + '401': *748 + '403': *751 '404': *6 - '409': *756 - '429': *750 - '500': *751 + '409': *758 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109866,17 +110231,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: - - *763 + - *765 - *39 responses: '204': description: User was deleted, no content - '400': *748 - '401': *746 - '403': *749 + '400': *750 + '401': *748 + '403': *751 '404': *6 - '429': *750 - '500': *751 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109967,7 +110332,7 @@ paths: - 1 Resources: type: array - items: &767 + items: &769 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -110214,22 +110579,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *35 - '404': &768 + '404': &770 description: Resource not found content: application/json: - schema: *745 + schema: *747 application/scim+json: - schema: *745 - '403': &769 + schema: *747 + '403': &771 description: Forbidden content: application/json: - schema: *745 + schema: *747 application/scim+json: - schema: *745 - '400': *748 - '429': *750 + schema: *747 + '400': *750 + '429': *752 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -110255,9 +110620,9 @@ paths: description: Response content: application/scim+json: - schema: *767 + schema: *769 examples: - default: &770 + default: &772 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -110280,17 +110645,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *35 - '404': *768 - '403': *769 - '500': *751 + '404': *770 + '403': *771 + '500': *753 '409': description: Conflict content: application/json: - schema: *745 + schema: *747 application/scim+json: - schema: *745 - '400': *748 + schema: *747 + '400': *750 requestBody: required: true content: @@ -110390,17 +110755,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *81 - - *763 + - *765 responses: '200': description: Response content: application/scim+json: - schema: *767 + schema: *769 examples: - default: *770 - '404': *768 - '403': *769 + default: *772 + '404': *770 + '403': *771 '304': *35 x-github: githubCloudOnly: true @@ -110424,18 +110789,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - *81 - - *763 + - *765 responses: '200': description: Response content: application/scim+json: - schema: *767 + schema: *769 examples: - default: *770 + default: *772 '304': *35 - '404': *768 - '403': *769 + '404': *770 + '403': *771 requestBody: required: true content: @@ -110550,19 +110915,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *81 - - *763 + - *765 responses: '200': description: Response content: application/scim+json: - schema: *767 + schema: *769 examples: - default: *770 + default: *772 '304': *35 - '404': *768 - '403': *769 - '400': *748 + '404': *770 + '403': *771 + '400': *750 '429': description: Response content: @@ -110658,12 +111023,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *81 - - *763 + - *765 responses: '204': description: Response - '404': *768 - '403': *769 + '404': *770 + '403': *771 '304': *35 x-github: githubCloudOnly: true @@ -110778,7 +111143,7 @@ paths: html_url: type: string format: uri - repository: *269 + repository: *273 score: type: number file_size: @@ -110797,7 +111162,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &771 + text_matches: &773 title: Search Result Text Matches type: array items: @@ -110961,7 +111326,7 @@ paths: enum: - author-date - committer-date - - &772 + - &774 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 @@ -111030,7 +111395,7 @@ paths: committer: anyOf: - type: 'null' - - *505 + - *506 comment_count: type: integer message: @@ -111049,7 +111414,7 @@ paths: url: type: string format: uri - verification: *622 + verification: *623 required: - author - committer @@ -111064,7 +111429,7 @@ paths: committer: anyOf: - type: 'null' - - *505 + - *506 parents: type: array items: @@ -111076,12 +111441,12 @@ paths: type: string sha: type: string - repository: *269 + repository: *273 score: type: number node_id: type: string - text_matches: *771 + text_matches: *773 required: - sha - node_id @@ -111274,7 +111639,7 @@ paths: - interactions - created - updated - - *772 + - *774 - *17 - *19 - name: advanced_search @@ -111371,11 +111736,11 @@ paths: type: - string - 'null' - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: type: string state_reason: @@ -111389,7 +111754,7 @@ paths: milestone: anyOf: - type: 'null' - - *387 + - *390 comments: type: integer created_at: @@ -111403,7 +111768,7 @@ paths: - string - 'null' format: date-time - text_matches: *771 + text_matches: *773 pull_request: type: object properties: @@ -111441,7 +111806,7 @@ paths: type: string score: type: number - author_association: *205 + author_association: *206 draft: type: boolean repository: *72 @@ -111452,12 +111817,12 @@ paths: timeline_url: type: string format: uri - type: *351 + type: *355 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *206 + reactions: *207 required: - assignee - closed_at @@ -111626,7 +111991,7 @@ paths: enum: - created - updated - - *772 + - *774 - *17 - *19 responses: @@ -111671,7 +112036,7 @@ paths: - 'null' score: type: number - text_matches: *771 + text_matches: *773 required: - id - node_id @@ -111757,7 +112122,7 @@ paths: - forks - help-wanted-issues - updated - - *772 + - *774 - *17 - *19 responses: @@ -111976,7 +112341,7 @@ paths: license: anyOf: - type: 'null' - - *219 + - *220 permissions: type: object properties: @@ -111994,7 +112359,7 @@ paths: - admin - pull - push - text_matches: *771 + text_matches: *773 temp_clone_token: type: string allow_merge_commit: @@ -112303,7 +112668,7 @@ paths: - string - 'null' format: uri - text_matches: *771 + text_matches: *773 related: type: - array @@ -112498,7 +112863,7 @@ paths: - followers - repositories - joined - - *772 + - *774 - *17 - *19 responses: @@ -112608,7 +112973,7 @@ paths: type: - boolean - 'null' - text_matches: *771 + text_matches: *773 blog: type: - string @@ -112690,7 +113055,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &776 + - &778 name: team_id description: The unique identifier of the team. in: path @@ -112702,9 +113067,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *432 examples: - default: *430 + default: *433 '404': *6 x-github: githubCloudOnly: false @@ -112731,7 +113096,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *776 + - *778 requestBody: required: true content: @@ -112795,16 +113160,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *429 + schema: *432 examples: - default: *430 + default: *433 '201': description: Response content: application/json: - schema: *429 + schema: *432 examples: - default: *430 + default: *433 '404': *6 '422': *15 '403': *27 @@ -112832,7 +113197,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *776 + - *778 responses: '204': description: Response @@ -112863,7 +113228,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *776 + - *778 - *104 - *17 - *19 @@ -112874,9 +113239,9 @@ paths: application/json: schema: type: array - items: *431 + items: *434 examples: - default: *777 + default: *779 headers: Link: *41 x-github: @@ -112905,7 +113270,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *776 + - *778 requestBody: required: true content: @@ -112939,9 +113304,9 @@ paths: description: Response content: application/json: - schema: *431 + schema: *434 examples: - default: *432 + default: *435 x-github: triggersNotification: true githubCloudOnly: false @@ -112968,16 +113333,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *776 - - *433 + - *778 + - *436 responses: '200': description: Response content: application/json: - schema: *431 + schema: *434 examples: - default: *432 + default: *435 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113002,8 +113367,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *776 - - *433 + - *778 + - *436 requestBody: required: false content: @@ -113026,9 +113391,9 @@ paths: description: Response content: application/json: - schema: *431 + schema: *434 examples: - default: *778 + default: *780 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113053,8 +113418,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *776 - - *433 + - *778 + - *436 responses: '204': description: Response @@ -113083,8 +113448,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *776 - - *433 + - *778 + - *436 - *104 - *17 - *19 @@ -113095,9 +113460,9 @@ paths: application/json: schema: type: array - items: *434 + items: *437 examples: - default: *779 + default: *781 headers: Link: *41 x-github: @@ -113126,8 +113491,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *776 - - *433 + - *778 + - *436 requestBody: required: true content: @@ -113149,9 +113514,9 @@ paths: description: Response content: application/json: - schema: *434 + schema: *437 examples: - default: *435 + default: *438 x-github: triggersNotification: true githubCloudOnly: false @@ -113178,17 +113543,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *776 - - *433 + - *778 - *436 + - *439 responses: '200': description: Response content: application/json: - schema: *434 + schema: *437 examples: - default: *435 + default: *438 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113213,9 +113578,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *776 - - *433 + - *778 - *436 + - *439 requestBody: required: true content: @@ -113237,9 +113602,9 @@ paths: description: Response content: application/json: - schema: *434 + schema: *437 examples: - default: *780 + default: *782 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113264,9 +113629,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *776 - - *433 + - *778 - *436 + - *439 responses: '204': description: Response @@ -113295,9 +113660,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: - - *776 - - *433 + - *778 - *436 + - *439 - 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. @@ -113323,9 +113688,9 @@ paths: application/json: schema: type: array - items: *437 + items: *440 examples: - default: *439 + default: *442 headers: Link: *41 x-github: @@ -113354,9 +113719,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: - - *776 - - *433 + - *778 - *436 + - *439 requestBody: required: true content: @@ -113388,9 +113753,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113416,8 +113781,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: - - *776 - - *433 + - *778 + - *436 - 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. @@ -113443,9 +113808,9 @@ paths: application/json: schema: type: array - items: *437 + items: *440 examples: - default: *439 + default: *442 headers: Link: *41 x-github: @@ -113474,8 +113839,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: - - *776 - - *433 + - *778 + - *436 requestBody: required: true content: @@ -113507,9 +113872,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -113533,7 +113898,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *776 + - *778 - *17 - *19 responses: @@ -113543,9 +113908,9 @@ paths: application/json: schema: type: array - items: *348 + items: *352 examples: - default: *349 + default: *353 headers: Link: *41 x-github: @@ -113571,7 +113936,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *776 + - *778 - name: role description: Filters members returned by their role in the team. in: query @@ -113594,7 +113959,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 '404': *6 @@ -113622,7 +113987,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *776 + - *778 - *132 responses: '204': @@ -113659,7 +114024,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *776 + - *778 - *132 responses: '204': @@ -113699,7 +114064,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *776 + - *778 - *132 responses: '204': @@ -113736,16 +114101,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: - - *776 + - *778 - *132 responses: '200': description: Response content: application/json: - schema: *445 + schema: *448 examples: - response-if-user-is-a-team-maintainer: *781 + response-if-user-is-a-team-maintainer: *783 '404': *6 x-github: githubCloudOnly: false @@ -113778,7 +114143,7 @@ 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: - - *776 + - *778 - *132 requestBody: required: false @@ -113804,9 +114169,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *448 examples: - response-if-users-membership-with-team-is-now-pending: *782 + response-if-users-membership-with-team-is-now-pending: *784 '403': description: Forbidden if team synchronization is set up '422': @@ -113840,7 +114205,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *776 + - *778 - *132 responses: '204': @@ -113869,7 +114234,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *776 + - *778 - *17 - *19 responses: @@ -113879,9 +114244,9 @@ paths: application/json: schema: type: array - items: *446 + items: *449 examples: - default: *783 + default: *785 headers: Link: *41 '404': *6 @@ -113907,16 +114272,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *776 - - *447 + - *778 + - *450 responses: '200': description: Response content: application/json: - schema: *446 + schema: *449 examples: - default: *784 + default: *786 '404': description: Not Found if project is not managed by this team x-github: @@ -113940,8 +114305,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *776 - - *447 + - *778 + - *450 requestBody: required: false content: @@ -114008,8 +114373,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *776 - - *447 + - *778 + - *450 responses: '204': description: Response @@ -114036,7 +114401,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *776 + - *778 - *17 - *19 responses: @@ -114046,9 +114411,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: *372 + default: *376 headers: Link: *41 '404': *6 @@ -114078,15 +114443,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: - - *776 - - *448 - - *449 + - *778 + - *451 + - *452 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *785 + schema: *787 examples: alternative-response-with-extra-repository-information: value: @@ -114237,9 +114602,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: - - *776 - - *448 - - *449 + - *778 + - *451 + - *452 requestBody: required: false content: @@ -114289,9 +114654,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: - - *776 - - *448 - - *449 + - *778 + - *451 + - *452 responses: '204': description: Response @@ -114320,15 +114685,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: - - *776 + - *778 responses: '200': description: Response content: application/json: - schema: *450 + schema: *453 examples: - default: *451 + default: *454 '403': *27 '404': *6 x-github: @@ -114355,7 +114720,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: - - *776 + - *778 requestBody: required: true content: @@ -114416,7 +114781,7 @@ paths: description: Response content: application/json: - schema: *450 + schema: *453 examples: default: value: @@ -114447,7 +114812,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *776 + - *778 - *17 - *19 responses: @@ -114457,9 +114822,9 @@ paths: application/json: schema: type: array - items: *296 + items: *300 examples: - response-if-child-teams-exist: *786 + response-if-child-teams-exist: *788 headers: Link: *41 '404': *6 @@ -114492,7 +114857,7 @@ paths: application/json: schema: oneOf: - - &788 + - &790 title: Private User description: Private User type: object @@ -114742,7 +115107,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *787 + - *789 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -114902,7 +115267,7 @@ paths: description: Response content: application/json: - schema: *788 + schema: *790 examples: default: value: @@ -114981,7 +115346,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 '304': *35 '404': *6 '403': *27 @@ -115105,9 +115470,9 @@ paths: type: integer codespaces: type: array - items: *356 + items: *360 examples: - default: *357 + default: *361 '304': *35 '500': *38 '401': *23 @@ -115246,17 +115611,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '401': *23 '403': *27 '404': *6 @@ -115300,7 +115665,7 @@ paths: type: integer secrets: type: array - items: &789 + items: &791 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -115342,7 +115707,7 @@ paths: - visibility - selected_repositories_url examples: - default: *557 + default: *558 headers: Link: *41 x-github: @@ -115414,13 +115779,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: - - *279 + - *283 responses: '200': description: Response content: application/json: - schema: *789 + schema: *791 examples: default: value: @@ -115450,7 +115815,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: - - *279 + - *283 requestBody: required: true content: @@ -115495,7 +115860,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -115523,7 +115888,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: - - *279 + - *283 responses: '204': description: Response @@ -115548,7 +115913,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: - - *279 + - *283 responses: '200': description: Response @@ -115564,9 +115929,9 @@ paths: type: integer repositories: type: array - items: *269 + items: *273 examples: - default: *790 + default: *792 '401': *23 '403': *27 '404': *6 @@ -115591,7 +115956,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: - - *279 + - *283 requestBody: required: true content: @@ -115645,7 +116010,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: - - *279 + - *283 - name: repository_id in: path required: true @@ -115678,7 +116043,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: - - *279 + - *283 - name: repository_id in: path required: true @@ -115710,15 +116075,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: - - *358 + - *362 responses: '200': description: Response content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '304': *35 '500': *38 '401': *23 @@ -115744,7 +116109,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: - - *358 + - *362 requestBody: required: false content: @@ -115774,9 +116139,9 @@ paths: description: Response content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '401': *23 '403': *27 '404': *6 @@ -115798,7 +116163,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: - - *358 + - *362 responses: '202': *37 '304': *35 @@ -115827,13 +116192,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: - - *358 + - *362 responses: '202': description: Response content: application/json: - schema: &791 + schema: &793 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -115886,7 +116251,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &792 + default: &794 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -115918,7 +116283,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *358 + - *362 - name: export_id in: path required: true @@ -115931,9 +116296,9 @@ paths: description: Response content: application/json: - schema: *791 + schema: *793 examples: - default: *792 + default: *794 '404': *6 x-github: githubCloudOnly: false @@ -115954,7 +116319,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *358 + - *362 responses: '200': description: Response @@ -115970,9 +116335,9 @@ paths: type: integer machines: type: array - items: *556 + items: *557 examples: - default: *793 + default: *795 '304': *35 '500': *38 '401': *23 @@ -116001,7 +116366,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: - - *358 + - *362 requestBody: required: true content: @@ -116057,11 +116422,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *461 + repository: *462 machine: anyOf: - type: 'null' - - *556 + - *557 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -116858,15 +117223,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: - - *358 + - *362 responses: '200': description: Response content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '304': *35 '500': *38 '400': *14 @@ -116898,15 +117263,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: - - *358 + - *362 responses: '200': description: Response content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '500': *38 '401': *23 '403': *27 @@ -116936,9 +117301,9 @@ paths: application/json: schema: type: array - items: *366 + items: *370 examples: - default: &804 + default: &806 value: - id: 197 name: hello_docker @@ -117039,7 +117404,7 @@ paths: application/json: schema: type: array - items: &794 + items: &796 title: Email description: Email type: object @@ -117109,9 +117474,9 @@ paths: application/json: schema: type: array - items: *794 + items: *796 examples: - default: &806 + default: &808 value: - email: octocat@github.com verified: true @@ -117188,7 +117553,7 @@ paths: application/json: schema: type: array - items: *794 + items: *796 examples: default: value: @@ -117300,7 +117665,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 '304': *35 @@ -117333,7 +117698,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 '304': *35 @@ -117446,7 +117811,7 @@ paths: application/json: schema: type: array - items: &795 + items: &797 title: GPG Key description: A unique encryption key type: object @@ -117591,7 +117956,7 @@ paths: - subkeys - revoked examples: - default: &820 + default: &822 value: - id: 3 name: Octocat's GPG Key @@ -117676,9 +118041,9 @@ paths: description: Response content: application/json: - schema: *795 + schema: *797 examples: - default: &796 + default: &798 value: id: 3 name: Octocat's GPG Key @@ -117735,7 +118100,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: - - &797 + - &799 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -117747,9 +118112,9 @@ paths: description: Response content: application/json: - schema: *795 + schema: *797 examples: - default: *796 + default: *798 '404': *6 '304': *35 '403': *27 @@ -117772,7 +118137,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: - - *797 + - *799 responses: '204': description: Response @@ -117963,7 +118328,7 @@ paths: type: array items: *72 examples: - default: *264 + default: *268 headers: Link: *41 '404': *6 @@ -117988,7 +118353,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *263 + - *267 responses: '204': description: Response @@ -118014,7 +118379,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *263 + - *267 responses: '204': description: Response @@ -118048,12 +118413,12 @@ paths: application/json: schema: anyOf: - - *346 + - *350 - type: object properties: {} additionalProperties: false examples: - default: *347 + default: *351 '204': description: Response when there are no restrictions x-github: @@ -118077,7 +118442,7 @@ paths: required: true content: application/json: - schema: *633 + schema: *634 examples: default: value: @@ -118088,7 +118453,7 @@ paths: description: Response content: application/json: - schema: *346 + schema: *350 examples: default: value: @@ -118169,7 +118534,7 @@ paths: - closed - all default: open - - *354 + - *358 - name: sort description: What to sort results by. in: query @@ -118182,7 +118547,7 @@ paths: - comments default: created - *104 - - *208 + - *209 - *17 - *19 responses: @@ -118192,9 +118557,9 @@ paths: application/json: schema: type: array - items: *218 + items: *219 examples: - default: *355 + default: *359 headers: Link: *41 '404': *6 @@ -118227,7 +118592,7 @@ paths: application/json: schema: type: array - items: &798 + items: &800 title: Key description: Key type: object @@ -118330,9 +118695,9 @@ paths: description: Response content: application/json: - schema: *798 + schema: *800 examples: - default: &799 + default: &801 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -118365,15 +118730,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: - - *660 + - *662 responses: '200': description: Response content: application/json: - schema: *798 + schema: *800 examples: - default: *799 + default: *801 '404': *6 '304': *35 '403': *27 @@ -118396,7 +118761,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: - - *660 + - *662 responses: '204': description: Response @@ -118429,7 +118794,7 @@ paths: application/json: schema: type: array - items: &800 + items: &802 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -118497,7 +118862,7 @@ paths: - id - type - login - plan: *221 + plan: *222 required: - billing_cycle - next_billing_date @@ -118508,7 +118873,7 @@ paths: - account - plan examples: - default: &801 + default: &803 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -118570,9 +118935,9 @@ paths: application/json: schema: type: array - items: *800 + items: *802 examples: - default: *801 + default: *803 headers: Link: *41 '304': *35 @@ -118612,7 +118977,7 @@ paths: application/json: schema: type: array - items: *359 + items: *363 examples: default: value: @@ -118720,7 +119085,7 @@ paths: description: Response content: application/json: - schema: *359 + schema: *363 examples: default: value: @@ -118803,7 +119168,7 @@ paths: description: Response content: application/json: - schema: *359 + schema: *363 examples: default: value: @@ -118871,7 +119236,7 @@ paths: application/json: schema: type: array - items: *361 + items: *365 examples: default: value: @@ -119133,7 +119498,7 @@ paths: description: Response content: application/json: - schema: *361 + schema: *365 examples: default: value: @@ -119313,7 +119678,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *362 + - *366 - name: exclude in: query required: false @@ -119326,7 +119691,7 @@ paths: description: Response content: application/json: - schema: *361 + schema: *365 examples: default: value: @@ -119520,7 +119885,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *362 + - *366 responses: '302': description: Response @@ -119546,7 +119911,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *362 + - *366 responses: '204': description: Response @@ -119575,8 +119940,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *362 - - *802 + - *366 + - *804 responses: '204': description: Response @@ -119600,7 +119965,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *362 + - *366 - *17 - *19 responses: @@ -119610,9 +119975,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: *372 + default: *376 headers: Link: *41 '404': *6 @@ -119649,7 +120014,7 @@ paths: type: array items: *67 examples: - default: *234 + default: *235 headers: Link: *41 '304': *35 @@ -119691,7 +120056,7 @@ paths: - docker - nuget - container - - *803 + - *805 - *19 - *17 responses: @@ -119701,10 +120066,10 @@ paths: application/json: schema: type: array - items: *366 + items: *370 examples: - default: *804 - '400': *805 + default: *806 + '400': *807 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -119724,16 +120089,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: - - *368 - - *369 + - *372 + - *373 responses: '200': description: Response content: application/json: - schema: *366 + schema: *370 examples: - default: &821 + default: &823 value: id: 40201 name: octo-name @@ -119846,8 +120211,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: - - *368 - - *369 + - *372 + - *373 responses: '204': description: Response @@ -119877,8 +120242,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: - - *368 - - *369 + - *372 + - *373 - name: token description: package token schema: @@ -119910,8 +120275,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: - - *368 - - *369 + - *372 + - *373 - *19 - *17 - name: state @@ -119931,7 +120296,7 @@ paths: application/json: schema: type: array - items: *370 + items: *374 examples: default: value: @@ -119980,15 +120345,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: - - *368 - - *369 - - *371 + - *372 + - *373 + - *375 responses: '200': description: Response content: application/json: - schema: *370 + schema: *374 examples: default: value: @@ -120024,9 +120389,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: - - *368 - - *369 - - *371 + - *372 + - *373 + - *375 responses: '204': description: Response @@ -120056,9 +120421,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: - - *368 - - *369 - - *371 + - *372 + - *373 + - *375 responses: '204': description: Response @@ -120070,99 +120435,6 @@ paths: enabledForGitHubApps: false category: packages subcategory: packages - "/user/projects": - post: - summary: Create a user 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: - - projects-classic - operationId: projects-classic/create-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-a-user-project - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - required: - - name - type: object - examples: - default: - summary: Create a new project - value: - name: My Projects - body: A board to manage my personal projects. - responses: - '201': - description: Response - content: - application/json: - schema: *382 - examples: - default: - value: - owner_url: https://api.github.com/users/octocat - url: https://api.github.com/projects/1002603 - html_url: https://github.com/users/octocat/projects/1 - columns_url: https://api.github.com/projects/1002603/columns - id: 1002603 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - name: My Projects - body: A board to manage my personal projects. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - '304': *35 - '403': *27 - '401': *23 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/user/public_emails": get: summary: List public email addresses for the authenticated user @@ -120188,9 +120460,9 @@ paths: application/json: schema: type: array - items: *794 + items: *796 examples: - default: *806 + default: *808 headers: Link: *41 '304': *35 @@ -120303,7 +120575,7 @@ paths: type: array items: *72 examples: - default: &813 + default: &815 summary: Default response value: - id: 1296269 @@ -120621,9 +120893,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *462 examples: - default: *463 + default: *464 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -120661,9 +120933,9 @@ paths: application/json: schema: type: array - items: *635 + items: *636 examples: - default: *807 + default: *809 headers: Link: *41 '304': *35 @@ -120686,7 +120958,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *350 + - *354 responses: '204': description: Response @@ -120709,7 +120981,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *350 + - *354 responses: '204': description: Response @@ -120742,7 +121014,7 @@ paths: application/json: schema: type: array - items: &808 + items: &810 title: Social account description: Social media account type: object @@ -120759,7 +121031,7 @@ paths: - provider - url examples: - default: &809 + default: &811 value: - provider: twitter url: https://twitter.com/github @@ -120822,9 +121094,9 @@ paths: application/json: schema: type: array - items: *808 + items: *810 examples: - default: *809 + default: *811 '422': *15 '304': *35 '404': *6 @@ -120912,7 +121184,7 @@ paths: application/json: schema: type: array - items: &810 + items: &812 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -120932,7 +121204,7 @@ paths: - title - created_at examples: - default: &826 + default: &828 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -120999,9 +121271,9 @@ paths: description: Response content: application/json: - schema: *810 + schema: *812 examples: - default: &811 + default: &813 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -121032,7 +121304,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: - - &812 + - &814 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -121044,9 +121316,9 @@ paths: description: Response content: application/json: - schema: *810 + schema: *812 examples: - default: *811 + default: *813 '404': *6 '304': *35 '403': *27 @@ -121069,7 +121341,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: - - *812 + - *814 responses: '204': description: Response @@ -121098,7 +121370,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: - - &827 + - &829 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 @@ -121123,11 +121395,11 @@ paths: type: array items: *72 examples: - default-response: *813 + default-response: *815 application/vnd.github.v3.star+json: schema: type: array - items: &828 + items: &830 title: Starred Repository description: Starred Repository type: object @@ -121283,8 +121555,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: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response if this repository is starred by you @@ -121312,8 +121584,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: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -121337,8 +121609,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: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -121371,9 +121643,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: *372 + default: *376 headers: Link: *41 '304': *35 @@ -121410,7 +121682,7 @@ paths: application/json: schema: type: array - items: *429 + items: *432 examples: default: value: @@ -121488,7 +121760,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *223 + - *224 responses: '200': description: Response @@ -121496,10 +121768,10 @@ paths: application/json: schema: oneOf: - - *788 - - *787 + - *790 + - *789 examples: - default-response: &815 + default-response: &817 summary: Default response value: login: octocat @@ -121534,7 +121806,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &816 + response-with-git-hub-plan-information: &818 summary: Response with GitHub plan information value: login: octocat @@ -121594,7 +121866,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *814 + - *816 - *17 responses: '200': @@ -121605,7 +121877,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: example: ; rel="next" @@ -121643,11 +121915,11 @@ paths: application/json: schema: oneOf: - - *788 - - *787 + - *790 + - *789 examples: - default-response: *815 - response-with-git-hub-plan-information: *816 + default-response: *817 + response-with-git-hub-plan-information: *818 '404': *6 x-github: githubCloudOnly: false @@ -121697,8 +121969,8 @@ paths: required: - subject_digests examples: - default: *817 - withPredicateType: *818 + default: *819 + withPredicateType: *820 responses: '200': description: Response @@ -121752,7 +122024,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *819 + default: *821 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -121957,12 +122229,12 @@ paths: initiator: type: string examples: - default: *501 + default: *502 '201': description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -121996,9 +122268,9 @@ paths: application/json: schema: type: array - items: *366 + items: *370 examples: - default: *804 + default: *806 '403': *27 '401': *23 x-github: @@ -122031,7 +122303,7 @@ paths: application/json: schema: type: array - items: *229 + items: *230 examples: default: value: @@ -122104,7 +122376,7 @@ paths: application/json: schema: type: array - items: *229 + items: *230 examples: default: value: @@ -122191,7 +122463,7 @@ paths: application/json: schema: type: array - items: *229 + items: *230 examples: default: value: @@ -122261,7 +122533,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 x-github: @@ -122292,7 +122564,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 x-github: @@ -122339,7 +122611,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - *132 - - *208 + - *209 - *17 - *19 responses: @@ -122349,9 +122621,9 @@ paths: application/json: schema: type: array - items: *209 + items: *210 examples: - default: *210 + default: *211 headers: Link: *41 '422': *15 @@ -122382,9 +122654,9 @@ paths: application/json: schema: type: array - items: *795 + items: *797 examples: - default: *820 + default: *822 headers: Link: *41 x-github: @@ -122488,7 +122760,7 @@ paths: application/json: schema: *20 examples: - default: *632 + default: *633 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122574,7 +122846,7 @@ paths: type: array items: *67 examples: - default: *234 + default: *235 headers: Link: *41 x-github: @@ -122613,7 +122885,7 @@ paths: - docker - nuget - container - - *803 + - *805 - *132 - *19 - *17 @@ -122624,12 +122896,12 @@ paths: application/json: schema: type: array - items: *366 + items: *370 examples: - default: *804 + default: *806 '403': *27 '401': *23 - '400': *805 + '400': *807 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122649,17 +122921,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *368 - - *369 + - *372 + - *373 - *132 responses: '200': description: Response content: application/json: - schema: *366 + schema: *370 examples: - default: *821 + default: *823 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122680,8 +122952,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *368 - - *369 + - *372 + - *373 - *132 responses: '204': @@ -122714,8 +122986,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *368 - - *369 + - *372 + - *373 - *132 - name: token description: package token @@ -122748,8 +123020,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-a-user parameters: - - *368 - - *369 + - *372 + - *373 - *132 responses: '200': @@ -122758,7 +123030,7 @@ paths: application/json: schema: type: array - items: *370 + items: *374 examples: default: value: @@ -122816,16 +123088,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: - - *368 - - *369 - - *371 + - *372 + - *373 + - *375 - *132 responses: '200': description: Response content: application/json: - schema: *370 + schema: *374 examples: default: value: @@ -122860,10 +123132,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *368 - - *369 + - *372 + - *373 - *132 - - *371 + - *375 responses: '204': description: Response @@ -122895,10 +123167,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *368 - - *369 + - *372 + - *373 - *132 - - *371 + - *375 responses: '204': description: Response @@ -122910,87 +123182,6 @@ paths: enabledForGitHubApps: false category: packages subcategory: packages - "/users/{username}/projects": - get: - summary: List user 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: - - projects-classic - operationId: projects-classic/list-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-user-projects - parameters: - - *132 - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *382 - examples: - default: - value: - - owner_url: https://api.github.com/users/octocat - url: https://api.github.com/projects/1002603 - html_url: https://github.com/users/octocat/projects/1 - columns_url: https://api.github.com/projects/1002603/columns - id: 1002603 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - name: My Projects - body: A board to manage my personal projects. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - headers: - Link: *41 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/users/{username}/projectsV2": get: summary: List projects for user @@ -123020,9 +123211,9 @@ paths: application/json: schema: type: array - items: *383 + items: *386 examples: - default: *384 + default: *387 headers: Link: *41 '304': *35 @@ -123044,16 +123235,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-user parameters: - - *385 + - *388 - *132 responses: '200': description: Response content: application/json: - schema: *383 + schema: *386 examples: - default: *384 + default: *387 headers: Link: *41 '304': *35 @@ -123075,7 +123266,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-user parameters: - - *385 + - *388 - *132 - *17 - *102 @@ -123087,9 +123278,9 @@ paths: application/json: schema: type: array - items: *386 + items: *389 examples: - default: *822 + default: *824 headers: Link: *41 '304': *35 @@ -123111,17 +123302,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - - *385 - - *823 + - *388 + - *825 - *132 responses: '200': description: Response content: application/json: - schema: *386 + schema: *389 examples: - default: *824 + default: *826 headers: Link: *41 '304': *35 @@ -123144,7 +123335,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-owned-project parameters: - - *385 + - *388 - *132 - *102 - *103 @@ -123177,9 +123368,9 @@ paths: application/json: schema: type: array - items: *391 + items: *394 examples: - default: *392 + default: *395 headers: Link: *41 '304': *35 @@ -123201,7 +123392,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-user-owned-project parameters: - *132 - - *385 + - *388 requestBody: required: true description: Details of the item to add to the project. @@ -123238,10 +123429,10 @@ paths: description: Response content: application/json: - schema: *825 + schema: *827 examples: - issue: *390 - pull_request: *390 + issue: *393 + pull_request: *393 '304': *35 '403': *27 '401': *23 @@ -123261,9 +123452,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: - - *385 + - *388 - *132 - - *393 + - *396 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -123283,9 +123474,9 @@ paths: description: Response content: application/json: - schema: *391 + schema: *394 examples: - default: *392 + default: *395 headers: Link: *41 '304': *35 @@ -123306,9 +123497,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-user parameters: - - *385 + - *388 - *132 - - *393 + - *396 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -123381,13 +123572,13 @@ paths: description: Response content: application/json: - schema: *391 + schema: *394 examples: - text_field: *392 - number_field: *392 - date_field: *392 - single_select_field: *392 - iteration_field: *392 + text_field: *395 + number_field: *395 + date_field: *395 + single_select_field: *395 + iteration_field: *395 '401': *23 '403': *27 '404': *6 @@ -123407,9 +123598,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-user parameters: - - *385 + - *388 - *132 - - *393 + - *396 responses: '204': description: Response @@ -123446,7 +123637,7 @@ paths: application/json: schema: type: array - items: *229 + items: *230 examples: default: value: @@ -123521,7 +123712,7 @@ paths: application/json: schema: type: array - items: *229 + items: *230 examples: default: value: @@ -123627,9 +123818,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: *372 + default: *376 headers: Link: *41 x-github: @@ -123659,9 +123850,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *419 examples: - default: *417 + default: *420 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -123689,9 +123880,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *424 examples: - default: *422 + default: *425 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -123712,11 +123903,11 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-a-user parameters: - *132 - - *190 - - *192 - *191 - - *236 - - *194 + - *193 + - *192 + - *240 + - *195 responses: '200': description: Response when getting a billing premium request usage report @@ -123852,9 +124043,9 @@ paths: description: Response content: application/json: - schema: *423 + schema: *426 examples: - default: *424 + default: *427 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -123875,9 +124066,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - *132 - - *190 - - *237 - *191 + - *241 + - *192 responses: '200': description: Response when getting a billing usage report @@ -123956,7 +124147,7 @@ paths: subcategory: enhanced-billing "/users/{username}/settings/billing/usage/summary": get: - summary: Get billing usage summary report for a user + summary: Get billing usage summary for a user description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. @@ -123969,18 +124160,18 @@ paths: operationId: billing/get-github-billing-usage-summary-report-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-report-for-a-user + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-for-a-user parameters: - *132 - - *190 - - *192 - *191 - - *240 - - *194 - - *241 + - *193 + - *192 + - *244 + - *195 + - *245 responses: '200': - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -124111,9 +124302,9 @@ paths: application/json: schema: type: array - items: *808 + items: *810 examples: - default: *809 + default: *811 headers: Link: *41 x-github: @@ -124143,9 +124334,9 @@ paths: application/json: schema: type: array - items: *810 + items: *812 examples: - default: *826 + default: *828 headers: Link: *41 x-github: @@ -124170,7 +124361,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - *132 - - *827 + - *829 - *104 - *17 - *19 @@ -124182,11 +124373,11 @@ paths: schema: anyOf: - type: array - items: *828 + items: *830 - type: array items: *72 examples: - default-response: *813 + default-response: *815 headers: Link: *41 x-github: @@ -124215,9 +124406,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: *372 + default: *376 headers: Link: *41 x-github: @@ -124346,7 +124537,7 @@ webhooks: type: string enum: - disabled - enterprise: &829 + enterprise: &831 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -124415,7 +124606,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &830 + installation: &832 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -124436,7 +124627,7 @@ webhooks: required: - id - node_id - organization: &831 + organization: &833 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -124509,7 +124700,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &832 + repository: &834 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -124538,7 +124729,7 @@ webhooks: license: anyOf: - type: 'null' - - *219 + - *220 organization: anyOf: - type: 'null' @@ -125422,10 +125613,10 @@ webhooks: type: string enum: - enabled - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -125501,11 +125692,11 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - rule: &833 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + rule: &835 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) @@ -125728,11 +125919,11 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - rule: *833 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + rule: *835 sender: *4 required: - action @@ -125920,11 +126111,11 @@ webhooks: - everyone required: - from - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - rule: *833 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + rule: *835 sender: *4 required: - action @@ -125995,7 +126186,7 @@ webhooks: required: true content: application/json: - schema: &836 + schema: &838 title: Exemption request cancellation event type: object properties: @@ -126003,11 +126194,11 @@ webhooks: type: string enum: - cancelled - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - exemption_request: &834 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + exemption_request: &836 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -126245,7 +126436,7 @@ webhooks: - array - 'null' description: The responses to the exemption request. - items: &835 + items: &837 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -126355,7 +126546,7 @@ webhooks: required: true content: application/json: - schema: &837 + schema: &839 title: Exemption request completed event type: object properties: @@ -126363,11 +126554,11 @@ webhooks: type: string enum: - completed - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - exemption_request: *834 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + exemption_request: *836 sender: *4 required: - action @@ -126437,7 +126628,7 @@ webhooks: required: true content: application/json: - schema: &838 + schema: &840 title: Exemption request created event type: object properties: @@ -126445,11 +126636,11 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - exemption_request: *834 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + exemption_request: *836 sender: *4 required: - action @@ -126519,7 +126710,7 @@ webhooks: required: true content: application/json: - schema: &839 + schema: &841 title: Exemption response dismissed event type: object properties: @@ -126527,12 +126718,12 @@ webhooks: type: string enum: - response_dismissed - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - exemption_request: *834 - exemption_response: *835 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + exemption_request: *836 + exemption_response: *837 sender: *4 required: - action @@ -126604,7 +126795,7 @@ webhooks: required: true content: application/json: - schema: &840 + schema: &842 title: Exemption response submitted event type: object properties: @@ -126612,12 +126803,12 @@ webhooks: type: string enum: - response_submitted - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - exemption_request: *834 - exemption_response: *835 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + exemption_request: *836 + exemption_response: *837 sender: *4 required: - action @@ -126690,7 +126881,7 @@ webhooks: required: true content: application/json: - schema: *836 + schema: *838 responses: '200': description: Return a 200 status to indicate that the data was received @@ -126757,7 +126948,7 @@ webhooks: required: true content: application/json: - schema: *837 + schema: *839 responses: '200': description: Return a 200 status to indicate that the data was received @@ -126824,7 +127015,7 @@ webhooks: required: true content: application/json: - schema: *838 + schema: *840 responses: '200': description: Return a 200 status to indicate that the data was received @@ -126891,7 +127082,7 @@ webhooks: required: true content: application/json: - schema: *839 + schema: *841 responses: '200': description: Return a 200 status to indicate that the data was received @@ -126959,7 +127150,7 @@ webhooks: required: true content: application/json: - schema: *840 + schema: *842 responses: '200': description: Return a 200 status to indicate that the data was received @@ -127037,7 +127228,7 @@ webhooks: type: string enum: - completed - check_run: &842 + check_run: &844 title: CheckRun description: A check performed on the code of a given code change type: object @@ -127102,8 +127293,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *518 - repository: *269 + items: *519 + repository: *273 status: type: string enum: @@ -127147,7 +127338,7 @@ webhooks: - examples: - neutral - deployment: *841 + deployment: *843 details_url: type: string examples: @@ -127207,7 +127398,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *518 + items: *519 started_at: type: string format: date-time @@ -127245,10 +127436,10 @@ webhooks: - output - app - pull_requests - installation: *830 - enterprise: *829 - organization: *831 - repository: *832 + installation: *832 + enterprise: *831 + organization: *833 + repository: *834 sender: *4 required: - check_run @@ -127641,11 +127832,11 @@ webhooks: type: string enum: - created - check_run: *842 - installation: *830 - enterprise: *829 - organization: *831 - repository: *832 + check_run: *844 + installation: *832 + enterprise: *831 + organization: *833 + repository: *834 sender: *4 required: - check_run @@ -128041,11 +128232,11 @@ webhooks: type: string enum: - requested_action - check_run: *842 - installation: *830 - enterprise: *829 - organization: *831 - repository: *832 + check_run: *844 + installation: *832 + enterprise: *831 + organization: *833 + repository: *834 requested_action: description: The action requested by the user. type: object @@ -128450,11 +128641,11 @@ webhooks: type: string enum: - rerequested - check_run: *842 - installation: *830 - enterprise: *829 - organization: *831 - repository: *832 + check_run: *844 + installation: *832 + enterprise: *831 + organization: *833 + repository: *834 sender: *4 required: - check_run @@ -129446,10 +129637,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -130134,10 +130325,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -130816,10 +131007,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -130988,7 +131179,7 @@ webhooks: required: - login - id - dismissed_comment: *530 + dismissed_comment: *531 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -131140,20 +131331,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &843 + commit_oid: &845 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: *829 - installation: *830 - organization: *831 - ref: &844 + enterprise: *831 + installation: *832 + organization: *833 + ref: &846 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: *832 + repository: *834 sender: *4 required: - action @@ -131320,7 +131511,7 @@ webhooks: required: - login - id - dismissed_comment: *530 + dismissed_comment: *531 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -131561,12 +131752,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *843 - enterprise: *829 - installation: *830 - organization: *831 - ref: *844 - repository: *832 + commit_oid: *845 + enterprise: *831 + installation: *832 + organization: *833 + ref: *846 + repository: *834 sender: *4 required: - action @@ -131664,7 +131855,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *530 + dismissed_comment: *531 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -131849,12 +132040,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *843 - enterprise: *829 - installation: *830 - organization: *831 - ref: *844 - repository: *832 + commit_oid: *845 + enterprise: *831 + installation: *832 + organization: *833 + ref: *846 + repository: *834 sender: *4 required: - action @@ -132023,7 +132214,7 @@ webhooks: required: - login - id - dismissed_comment: *530 + dismissed_comment: *531 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -132200,12 +132391,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *843 - enterprise: *829 - installation: *830 - organization: *831 - ref: *844 - repository: *832 + commit_oid: *845 + enterprise: *831 + installation: *832 + organization: *833 + ref: *846 + repository: *834 sender: *4 required: - action @@ -132308,7 +132499,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *530 + dismissed_comment: *531 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -132488,9 +132679,9 @@ webhooks: type: - string - 'null' - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -132498,7 +132689,7 @@ webhooks: type: - string - 'null' - repository: *832 + repository: *834 sender: *4 required: - action @@ -132597,7 +132788,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *530 + dismissed_comment: *531 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -132744,12 +132935,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *843 - enterprise: *829 - installation: *830 - organization: *831 - ref: *844 - repository: *832 + commit_oid: *845 + enterprise: *831 + installation: *832 + organization: *833 + ref: *846 + repository: *834 sender: *4 required: - action @@ -133011,10 +133202,10 @@ webhooks: - updated_at - author_association - body - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -133095,18 +133286,18 @@ webhooks: type: - string - 'null' - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *831 - pusher_type: &845 + organization: *833 + pusher_type: &847 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &846 + ref: &848 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -133116,7 +133307,7 @@ webhooks: enum: - tag - branch - repository: *832 + repository: *834 sender: *4 required: - ref @@ -133199,9 +133390,9 @@ webhooks: enum: - created definition: *146 - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 sender: *4 required: - action @@ -133286,9 +133477,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 sender: *4 required: - action @@ -133366,9 +133557,9 @@ webhooks: enum: - promote_to_enterprise definition: *146 - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 sender: *4 required: - action @@ -133446,9 +133637,9 @@ webhooks: enum: - updated definition: *146 - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 sender: *4 required: - action @@ -133525,10 +133716,10 @@ webhooks: type: string enum: - updated - enterprise: *829 - installation: *830 - repository: *832 - organization: *831 + enterprise: *831 + installation: *832 + repository: *834 + organization: *833 sender: *4 new_property_values: type: array @@ -133613,18 +133804,18 @@ webhooks: title: delete event type: object properties: - enterprise: *829 - installation: *830 - organization: *831 - pusher_type: *845 - ref: *846 + enterprise: *831 + installation: *832 + organization: *833 + pusher_type: *847 + ref: *848 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *832 + repository: *834 sender: *4 required: - ref @@ -133708,11 +133899,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *582 - installation: *830 - organization: *831 - enterprise: *829 - repository: *832 + alert: *583 + installation: *832 + organization: *833 + enterprise: *831 + repository: *834 sender: *4 required: - action @@ -133796,11 +133987,11 @@ webhooks: type: string enum: - auto_reopened - alert: *582 - installation: *830 - organization: *831 - enterprise: *829 - repository: *832 + alert: *583 + installation: *832 + organization: *833 + enterprise: *831 + repository: *834 sender: *4 required: - action @@ -133884,11 +134075,11 @@ webhooks: type: string enum: - created - alert: *582 - installation: *830 - organization: *831 - enterprise: *829 - repository: *832 + alert: *583 + installation: *832 + organization: *833 + enterprise: *831 + repository: *834 sender: *4 required: - action @@ -133970,11 +134161,11 @@ webhooks: type: string enum: - dismissed - alert: *582 - installation: *830 - organization: *831 - enterprise: *829 - repository: *832 + alert: *583 + installation: *832 + organization: *833 + enterprise: *831 + repository: *834 sender: *4 required: - action @@ -134056,11 +134247,11 @@ webhooks: type: string enum: - fixed - alert: *582 - installation: *830 - organization: *831 - enterprise: *829 - repository: *832 + alert: *583 + installation: *832 + organization: *833 + enterprise: *831 + repository: *834 sender: *4 required: - action @@ -134143,11 +134334,11 @@ webhooks: type: string enum: - reintroduced - alert: *582 - installation: *830 - organization: *831 - enterprise: *829 - repository: *832 + alert: *583 + installation: *832 + organization: *833 + enterprise: *831 + repository: *834 sender: *4 required: - action @@ -134229,11 +134420,11 @@ webhooks: type: string enum: - reopened - alert: *582 - installation: *830 - organization: *831 - enterprise: *829 - repository: *832 + alert: *583 + installation: *832 + organization: *833 + enterprise: *831 + repository: *834 sender: *4 required: - action @@ -134310,9 +134501,9 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - key: &847 + enterprise: *831 + installation: *832 + key: &849 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -134350,8 +134541,8 @@ webhooks: - verified - created_at - read_only - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -134428,11 +134619,11 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - key: *847 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + key: *849 + organization: *833 + repository: *834 sender: *4 required: - action @@ -135004,12 +135195,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - workflow: &851 + workflow: &853 title: Workflow type: - object @@ -135747,13 +135938,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *588 + deployment: *589 pull_requests: type: array - items: *680 - repository: *832 - organization: *831 - installation: *830 + items: *682 + repository: *834 + organization: *833 + installation: *832 sender: *4 responses: '200': @@ -135824,7 +136015,7 @@ webhooks: type: string enum: - approved - approver: &848 + approver: &850 type: object properties: avatar_url: @@ -135867,11 +136058,11 @@ webhooks: type: string comment: type: string - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - reviewers: &849 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + reviewers: &851 type: array items: type: object @@ -135952,7 +136143,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &850 + workflow_job_run: &852 type: object properties: conclusion: @@ -136698,18 +136889,18 @@ webhooks: type: string enum: - rejected - approver: *848 + approver: *850 comment: type: string - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - reviewers: *849 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + reviewers: *851 sender: *4 since: type: string - workflow_job_run: *850 + workflow_job_run: *852 workflow_job_runs: type: array items: @@ -137426,13 +137617,13 @@ webhooks: type: string enum: - requested - enterprise: *829 + enterprise: *831 environment: type: string - installation: *830 - organization: *831 - repository: *832 - requestor: &856 + installation: *832 + organization: *833 + repository: *834 + requestor: &858 title: User type: - object @@ -139375,12 +139566,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - workflow: *851 + workflow: *853 workflow_run: title: Deployment Workflow Run type: @@ -140071,7 +140262,7 @@ webhooks: type: string enum: - answered - answer: &854 + answer: &856 type: object properties: author_association: @@ -140231,7 +140422,7 @@ webhooks: - created_at - updated_at - body - discussion: &852 + discussion: &854 title: Discussion description: A Discussion in a repository. type: object @@ -140527,7 +140718,7 @@ webhooks: - id labels: type: array - items: *643 + items: *645 required: - repository_url - category @@ -140549,10 +140740,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -140679,11 +140870,11 @@ webhooks: - from required: - category - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -140766,11 +140957,11 @@ webhooks: type: string enum: - closed - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -140852,7 +141043,7 @@ webhooks: type: string enum: - created - comment: &853 + comment: &855 type: object properties: author_association: @@ -141012,11 +141203,11 @@ webhooks: - updated_at - body - reactions - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141099,12 +141290,12 @@ webhooks: type: string enum: - deleted - comment: *853 - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + comment: *855 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141199,12 +141390,12 @@ webhooks: - from required: - body - comment: *853 - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + comment: *855 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141288,11 +141479,11 @@ webhooks: type: string enum: - created - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141374,11 +141565,11 @@ webhooks: type: string enum: - deleted - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141478,11 +141669,11 @@ webhooks: type: string required: - from - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141564,10 +141755,10 @@ webhooks: type: string enum: - labeled - discussion: *852 - enterprise: *829 - installation: *830 - label: &855 + discussion: *854 + enterprise: *831 + installation: *832 + label: &857 title: Label type: object properties: @@ -141600,8 +141791,8 @@ webhooks: - color - default - description - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141684,11 +141875,11 @@ webhooks: type: string enum: - locked - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141770,11 +141961,11 @@ webhooks: type: string enum: - pinned - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141856,11 +142047,11 @@ webhooks: type: string enum: - reopened - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141945,16 +142136,16 @@ webhooks: changes: type: object properties: - new_discussion: *852 - new_repository: *832 + new_discussion: *854 + new_repository: *834 required: - new_discussion - new_repository - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -142037,10 +142228,10 @@ webhooks: type: string enum: - unanswered - discussion: *852 - old_answer: *854 - organization: *831 - repository: *832 + discussion: *854 + old_answer: *856 + organization: *833 + repository: *834 sender: *4 required: - action @@ -142122,12 +142313,12 @@ webhooks: type: string enum: - unlabeled - discussion: *852 - enterprise: *829 - installation: *830 - label: *855 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + label: *857 + organization: *833 + repository: *834 sender: *4 required: - action @@ -142210,11 +142401,11 @@ webhooks: type: string enum: - unlocked - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -142296,11 +142487,11 @@ webhooks: type: string enum: - unpinned - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -142369,7 +142560,7 @@ webhooks: required: true content: application/json: - schema: *838 + schema: *840 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142432,7 +142623,7 @@ webhooks: required: true content: application/json: - schema: *840 + schema: *842 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142498,7 +142689,7 @@ webhooks: required: true content: application/json: - schema: *836 + schema: *838 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142564,7 +142755,7 @@ webhooks: required: true content: application/json: - schema: *837 + schema: *839 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142630,7 +142821,7 @@ webhooks: required: true content: application/json: - schema: *838 + schema: *840 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142696,7 +142887,7 @@ webhooks: required: true content: application/json: - schema: *839 + schema: *841 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142762,7 +142953,7 @@ webhooks: required: true content: application/json: - schema: *840 + schema: *842 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142829,7 +143020,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *829 + enterprise: *831 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -143507,9 +143698,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *830 - organization: *831 - repository: *832 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - forkee @@ -143655,9 +143846,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 pages: description: The pages that were updated. type: array @@ -143695,7 +143886,7 @@ webhooks: - action - sha - html_url - repository: *832 + repository: *834 sender: *4 required: - pages @@ -143771,10 +143962,10 @@ webhooks: type: string enum: - created - enterprise: *829 + enterprise: *831 installation: *20 - organization: *831 - repositories: &857 + organization: *833 + repositories: &859 description: An array of repository objects that the installation can access. type: array @@ -143800,8 +143991,8 @@ webhooks: - name - full_name - private - repository: *832 - requester: *856 + repository: *834 + requester: *858 sender: *4 required: - action @@ -143876,11 +144067,11 @@ webhooks: type: string enum: - deleted - enterprise: *829 + enterprise: *831 installation: *20 - organization: *831 - repositories: *857 - repository: *832 + organization: *833 + repositories: *859 + repository: *834 requester: type: - 'null' @@ -143957,11 +144148,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *829 + enterprise: *831 installation: *20 - organization: *831 - repositories: *857 - repository: *832 + organization: *833 + repositories: *859 + repository: *834 requester: type: - 'null' @@ -144038,10 +144229,10 @@ webhooks: type: string enum: - added - enterprise: *829 + enterprise: *831 installation: *20 - organization: *831 - repositories_added: &858 + organization: *833 + repositories_added: &860 description: An array of repository objects, which were added to the installation. type: array @@ -144087,15 +144278,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *832 - repository_selection: &859 + repository: *834 + repository_selection: &861 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *856 + requester: *858 sender: *4 required: - action @@ -144174,10 +144365,10 @@ webhooks: type: string enum: - removed - enterprise: *829 + enterprise: *831 installation: *20 - organization: *831 - repositories_added: *858 + organization: *833 + repositories_added: *860 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -144204,9 +144395,9 @@ webhooks: - name - full_name - private - repository: *832 - repository_selection: *859 - requester: *856 + repository: *834 + repository_selection: *861 + requester: *858 sender: *4 required: - action @@ -144285,11 +144476,11 @@ webhooks: type: string enum: - suspend - enterprise: *829 + enterprise: *831 installation: *20 - organization: *831 - repositories: *857 - repository: *832 + organization: *833 + repositories: *859 + repository: *834 requester: type: - 'null' @@ -144472,10 +144663,10 @@ webhooks: type: string required: - from - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 target_type: type: string @@ -144554,11 +144745,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *829 + enterprise: *831 installation: *20 - organization: *831 - repositories: *857 - repository: *832 + organization: *833 + repositories: *859 + repository: *834 requester: type: - 'null' @@ -144806,8 +144997,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -145624,8 +145815,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145642,7 +145833,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -145986,8 +146177,8 @@ webhooks: - state - locked - assignee - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -146067,7 +146258,7 @@ webhooks: type: string enum: - deleted - comment: &860 + comment: &862 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -146234,8 +146425,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -147048,8 +147239,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147066,7 +147257,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -147412,8 +147603,8 @@ webhooks: - state - locked - assignee - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -147493,7 +147684,7 @@ webhooks: type: string enum: - edited - changes: &884 + changes: &886 description: The changes to the comment. type: object properties: @@ -147505,9 +147696,9 @@ webhooks: type: string required: - from - comment: *860 - enterprise: *829 - installation: *830 + comment: *862 + enterprise: *831 + installation: *832 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -148323,8 +148514,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148341,7 +148532,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -148685,8 +148876,8 @@ webhooks: - state - locked - assignee - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -148770,15 +148961,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *218 + blocked_issue: *219 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *218 + blocking_issue: *219 blocking_issue_repo: *72 - installation: *830 - organization: *831 - repository: *832 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -148866,15 +149057,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *218 + blocked_issue: *219 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *218 + blocking_issue: *219 blocking_issue_repo: *72 - installation: *830 - organization: *831 - repository: *832 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -148961,15 +149152,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *218 + blocked_issue: *219 blocked_issue_repo: *72 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *218 - installation: *830 - organization: *831 - repository: *832 + blocking_issue: *219 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -149057,15 +149248,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *218 + blocked_issue: *219 blocked_issue_repo: *72 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *218 - installation: *830 - organization: *831 - repository: *832 + blocking_issue: *219 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -149150,10 +149341,10 @@ webhooks: type: string enum: - assigned - assignee: *856 - enterprise: *829 - installation: *830 - issue: &863 + assignee: *858 + enterprise: *831 + installation: *832 + issue: &865 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -149965,11 +150156,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149986,7 +150177,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -150089,8 +150280,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -150170,8 +150361,8 @@ webhooks: type: string enum: - closed - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -150988,11 +151179,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151009,7 +151200,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -151255,8 +151446,8 @@ webhooks: required: - state - closed_at - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -151335,8 +151526,8 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -152144,11 +152335,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152165,7 +152356,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -152267,8 +152458,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -152347,8 +152538,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -153179,11 +153370,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153200,7 +153391,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -153281,7 +153472,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &861 + milestone: &863 title: Milestone description: A collection of related issues and pull requests. type: object @@ -153424,8 +153615,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -153524,8 +153715,8 @@ webhooks: type: string required: - from - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -154337,11 +154528,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154355,7 +154546,7 @@ webhooks: timeline_url: type: string format: uri - type: *351 + type: *355 title: description: Title of the issue type: string @@ -154461,9 +154652,9 @@ webhooks: - active_lock_reason - body - reactions - label: *855 - organization: *831 - repository: *832 + label: *857 + organization: *833 + repository: *834 sender: *4 required: - action @@ -154543,8 +154734,8 @@ webhooks: type: string enum: - labeled - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -155355,11 +155546,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155373,7 +155564,7 @@ webhooks: timeline_url: type: string format: uri - type: *351 + type: *355 title: description: Title of the issue type: string @@ -155479,9 +155670,9 @@ webhooks: - active_lock_reason - body - reactions - label: *855 - organization: *831 - repository: *832 + label: *857 + organization: *833 + repository: *834 sender: *4 required: - action @@ -155561,8 +155752,8 @@ webhooks: type: string enum: - locked - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -156398,11 +156589,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156416,7 +156607,7 @@ webhooks: timeline_url: type: string format: uri - type: *351 + type: *355 title: description: Title of the issue type: string @@ -156499,8 +156690,8 @@ webhooks: format: uri user_view_type: type: string - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -156579,8 +156770,8 @@ webhooks: type: string enum: - milestoned - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -157410,11 +157601,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157431,7 +157622,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -157511,9 +157702,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *861 - organization: *831 - repository: *832 + milestone: *863 + organization: *833 + repository: *834 sender: *4 required: - action @@ -158405,11 +158596,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -158505,7 +158696,7 @@ webhooks: required: - login - id - type: *351 + type: *355 required: - id - number @@ -158986,8 +159177,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -159799,11 +159990,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159820,7 +160011,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -159922,8 +160113,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -160003,9 +160194,9 @@ webhooks: type: string enum: - pinned - enterprise: *829 - installation: *830 - issue: &862 + enterprise: *831 + installation: *832 + issue: &864 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -160811,11 +161002,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160832,7 +161023,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -160934,8 +161125,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -161014,8 +161205,8 @@ webhooks: type: string enum: - reopened - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -161849,11 +162040,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -161950,9 +162141,9 @@ webhooks: format: uri user_view_type: type: string - type: *351 - organization: *831 - repository: *832 + type: *355 + organization: *833 + repository: *834 sender: *4 required: - action @@ -162841,11 +163032,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -162862,7 +163053,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -163444,11 +163635,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *829 - installation: *830 - issue: *862 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + issue: *864 + organization: *833 + repository: *834 sender: *4 required: - action @@ -163528,12 +163719,12 @@ webhooks: type: string enum: - typed - enterprise: *829 - installation: *830 - issue: *863 - type: *351 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + issue: *865 + type: *355 + organization: *833 + repository: *834 sender: *4 required: - action @@ -163614,7 +163805,7 @@ webhooks: type: string enum: - unassigned - assignee: &887 + assignee: &889 title: User type: - object @@ -163686,11 +163877,11 @@ webhooks: required: - login - id - enterprise: *829 - installation: *830 - issue: *863 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + issue: *865 + organization: *833 + repository: *834 sender: *4 required: - action @@ -163769,12 +163960,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *829 - installation: *830 - issue: *863 - label: *855 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + issue: *865 + label: *857 + organization: *833 + repository: *834 sender: *4 required: - action @@ -163854,8 +164045,8 @@ webhooks: type: string enum: - unlocked - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -164689,11 +164880,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -164710,7 +164901,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -164790,8 +164981,8 @@ webhooks: format: uri user_view_type: type: string - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -164871,11 +165062,11 @@ webhooks: type: string enum: - unpinned - enterprise: *829 - installation: *830 - issue: *862 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + issue: *864 + organization: *833 + repository: *834 sender: *4 required: - action @@ -164954,12 +165145,12 @@ webhooks: type: string enum: - untyped - enterprise: *829 - installation: *830 - issue: *863 - type: *351 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + issue: *865 + type: *355 + organization: *833 + repository: *834 sender: *4 required: - action @@ -165039,11 +165230,11 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - label: *855 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + label: *857 + organization: *833 + repository: *834 sender: *4 required: - action @@ -165121,11 +165312,11 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - label: *855 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + label: *857 + organization: *833 + repository: *834 sender: *4 required: - action @@ -165235,11 +165426,11 @@ webhooks: type: string required: - from - enterprise: *829 - installation: *830 - label: *855 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + label: *857 + organization: *833 + repository: *834 sender: *4 required: - action @@ -165321,9 +165512,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *829 - installation: *830 - marketplace_purchase: &864 + enterprise: *831 + installation: *832 + marketplace_purchase: &866 title: Marketplace Purchase type: object required: @@ -165411,8 +165602,8 @@ webhooks: type: integer unit_count: type: integer - organization: *831 - previous_marketplace_purchase: &865 + organization: *833 + previous_marketplace_purchase: &867 title: Marketplace Purchase type: object properties: @@ -165496,7 +165687,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *832 + repository: *834 sender: *4 required: - action @@ -165576,10 +165767,10 @@ webhooks: - changed effective_date: type: string - enterprise: *829 - installation: *830 - marketplace_purchase: *864 - organization: *831 + enterprise: *831 + installation: *832 + marketplace_purchase: *866 + organization: *833 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -165667,7 +165858,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *832 + repository: *834 sender: *4 required: - action @@ -165749,10 +165940,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *829 - installation: *830 - marketplace_purchase: *864 - organization: *831 + enterprise: *831 + installation: *832 + marketplace_purchase: *866 + organization: *833 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -165838,7 +166029,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *832 + repository: *834 sender: *4 required: - action @@ -165919,8 +166110,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 marketplace_purchase: title: Marketplace Purchase type: object @@ -166006,9 +166197,9 @@ webhooks: type: integer unit_count: type: integer - organization: *831 - previous_marketplace_purchase: *865 - repository: *832 + organization: *833 + previous_marketplace_purchase: *867 + repository: *834 sender: *4 required: - action @@ -166088,12 +166279,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *829 - installation: *830 - marketplace_purchase: *864 - organization: *831 - previous_marketplace_purchase: *865 - repository: *832 + enterprise: *831 + installation: *832 + marketplace_purchase: *866 + organization: *833 + previous_marketplace_purchase: *867 + repository: *834 sender: *4 required: - action @@ -166195,11 +166386,11 @@ webhooks: type: string required: - to - enterprise: *829 - installation: *830 - member: *856 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + member: *858 + organization: *833 + repository: *834 sender: *4 required: - action @@ -166301,11 +166492,11 @@ webhooks: type: - string - 'null' - enterprise: *829 - installation: *830 - member: *856 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + member: *858 + organization: *833 + repository: *834 sender: *4 required: - action @@ -166384,11 +166575,11 @@ webhooks: type: string enum: - removed - enterprise: *829 - installation: *830 - member: *856 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + member: *858 + organization: *833 + repository: *834 sender: *4 required: - action @@ -166466,11 +166657,11 @@ webhooks: type: string enum: - added - enterprise: *829 - installation: *830 - member: *856 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + member: *858 + organization: *833 + repository: *834 scope: description: The scope of the membership. Currently, can only be `team`. @@ -166548,7 +166739,7 @@ webhooks: required: - login - id - team: &866 + team: &868 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -166778,11 +166969,11 @@ webhooks: type: string enum: - removed - enterprise: *829 - installation: *830 - member: *856 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + member: *858 + organization: *833 + repository: *834 scope: description: The scope of the membership. Currently, can only be `team`. @@ -166861,7 +167052,7 @@ webhooks: required: - login - id - team: *866 + team: *868 required: - action - scope @@ -166943,8 +167134,8 @@ webhooks: type: string enum: - checks_requested - installation: *830 - merge_group: &867 + installation: *832 + merge_group: &869 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -166963,15 +167154,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *522 + head_commit: *523 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -167057,10 +167248,10 @@ webhooks: - merged - invalidated - dequeued - installation: *830 - merge_group: *867 - organization: *831 - repository: *832 + installation: *832 + merge_group: *869 + organization: *833 + repository: *834 sender: *4 required: - action @@ -167133,7 +167324,7 @@ webhooks: type: string enum: - deleted - enterprise: *829 + enterprise: *831 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -167242,12 +167433,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *830 - organization: *831 + installation: *832 + organization: *833 repository: anyOf: - type: 'null' - - *832 + - *834 sender: *4 required: - action @@ -167327,11 +167518,11 @@ webhooks: type: string enum: - closed - enterprise: *829 - installation: *830 - milestone: *861 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + milestone: *863 + organization: *833 + repository: *834 sender: *4 required: - action @@ -167410,9 +167601,9 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - milestone: &868 + enterprise: *831 + installation: *832 + milestone: &870 title: Milestone description: A collection of related issues and pull requests. type: object @@ -167554,8 +167745,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -167634,11 +167825,11 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - milestone: *861 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + milestone: *863 + organization: *833 + repository: *834 sender: *4 required: - action @@ -167748,11 +167939,11 @@ webhooks: type: string required: - from - enterprise: *829 - installation: *830 - milestone: *861 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + milestone: *863 + organization: *833 + repository: *834 sender: *4 required: - action @@ -167832,11 +168023,11 @@ webhooks: type: string enum: - opened - enterprise: *829 - installation: *830 - milestone: *868 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + milestone: *870 + organization: *833 + repository: *834 sender: *4 required: - action @@ -167915,11 +168106,11 @@ webhooks: type: string enum: - blocked - blocked_user: *856 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + blocked_user: *858 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -167998,11 +168189,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *856 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + blocked_user: *858 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -168078,7 +168269,7 @@ webhooks: enum: - created definition: *140 - enterprise: *829 + enterprise: *831 sender: *4 required: - action @@ -168158,8 +168349,8 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 sender: *4 required: - action @@ -168232,8 +168423,8 @@ webhooks: enum: - updated definition: *140 - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 sender: *4 required: - action @@ -168305,9 +168496,9 @@ webhooks: type: string enum: - updated - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 sender: *4 new_property_values: type: array @@ -168395,9 +168586,9 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - membership: &869 + enterprise: *831 + installation: *832 + membership: &871 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -168507,8 +168698,8 @@ webhooks: - role - organization_url - user - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -168586,11 +168777,11 @@ webhooks: type: string enum: - member_added - enterprise: *829 - installation: *830 - membership: *869 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + membership: *871 + organization: *833 + repository: *834 sender: *4 required: - action @@ -168669,8 +168860,8 @@ webhooks: type: string enum: - member_invited - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -168792,10 +168983,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 - user: *856 + user: *858 required: - action - invitation @@ -168873,11 +169064,11 @@ webhooks: type: string enum: - member_removed - enterprise: *829 - installation: *830 - membership: *869 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + membership: *871 + organization: *833 + repository: *834 sender: *4 required: - action @@ -168964,11 +169155,11 @@ webhooks: properties: from: type: string - enterprise: *829 - installation: *830 - membership: *869 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + membership: *871 + organization: *833 + repository: *834 sender: *4 required: - action @@ -169044,9 +169235,9 @@ webhooks: type: string enum: - published - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 package: description: Information about the package. type: object @@ -169569,7 +169760,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &870 + items: &872 title: Ruby Gems metadata type: object properties: @@ -169666,7 +169857,7 @@ webhooks: - owner - package_version - registry - repository: *832 + repository: *834 sender: *4 required: - action @@ -169742,9 +169933,9 @@ webhooks: type: string enum: - updated - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 package: description: Information about the package. type: object @@ -170106,7 +170297,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *870 + items: *872 source_url: type: string format: uri @@ -170177,7 +170368,7 @@ webhooks: - owner - package_version - registry - repository: *832 + repository: *834 sender: *4 required: - action @@ -170358,12 +170549,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *829 + enterprise: *831 id: type: integer - installation: *830 - organization: *831 - repository: *832 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - id @@ -170440,7 +170631,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &871 + personal_access_token_request: &873 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -170590,10 +170781,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *829 - organization: *831 + enterprise: *831 + organization: *833 sender: *4 - installation: *830 + installation: *832 required: - action - personal_access_token_request @@ -170670,11 +170861,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *871 - enterprise: *829 - organization: *831 + personal_access_token_request: *873 + enterprise: *831 + organization: *833 sender: *4 - installation: *830 + installation: *832 required: - action - personal_access_token_request @@ -170750,11 +170941,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *871 - enterprise: *829 - organization: *831 + personal_access_token_request: *873 + enterprise: *831 + organization: *833 sender: *4 - installation: *830 + installation: *832 required: - action - personal_access_token_request @@ -170829,11 +171020,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *871 - organization: *831 - enterprise: *829 + personal_access_token_request: *873 + organization: *833 + enterprise: *831 sender: *4 - installation: *830 + installation: *832 required: - action - personal_access_token_request @@ -170938,7 +171129,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *872 + last_response: *874 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -170970,8 +171161,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 zen: description: Random string of GitHub zen. @@ -171216,10 +171407,10 @@ webhooks: - from required: - note - enterprise: *829 - installation: *830 - organization: *831 - project_card: &873 + enterprise: *831 + installation: *832 + organization: *833 + project_card: &875 title: Project Card type: object properties: @@ -171342,7 +171533,7 @@ webhooks: - creator - created_at - updated_at - repository: *832 + repository: *834 sender: *4 required: - action @@ -171423,11 +171614,11 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - project_card: *873 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + project_card: *875 + repository: *834 sender: *4 required: - action @@ -171507,9 +171698,9 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 project_card: title: Project Card type: object @@ -171639,7 +171830,7 @@ webhooks: repository: anyOf: - type: 'null' - - *832 + - *834 sender: *4 required: - action @@ -171733,11 +171924,11 @@ webhooks: - from required: - note - enterprise: *829 - installation: *830 - organization: *831 - project_card: *873 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + project_card: *875 + repository: *834 sender: *4 required: - action @@ -171831,9 +172022,9 @@ webhooks: - from required: - column_id - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 project_card: allOf: - title: Project Card @@ -172030,7 +172221,7 @@ webhooks: type: string required: - after_id - repository: *832 + repository: *834 sender: *4 required: - action @@ -172110,10 +172301,10 @@ webhooks: type: string enum: - closed - enterprise: *829 - installation: *830 - organization: *831 - project: &875 + enterprise: *831 + installation: *832 + organization: *833 + project: &877 title: Project type: object properties: @@ -172240,7 +172431,7 @@ webhooks: - creator - created_at - updated_at - repository: *832 + repository: *834 sender: *4 required: - action @@ -172320,10 +172511,10 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - project_column: &874 + enterprise: *831 + installation: *832 + organization: *833 + project_column: &876 title: Project Column type: object properties: @@ -172363,7 +172554,7 @@ webhooks: - name - created_at - updated_at - repository: *832 + repository: *834 sender: *4 required: - action @@ -172442,14 +172633,14 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - organization: *831 - project_column: *874 + enterprise: *831 + installation: *832 + organization: *833 + project_column: *876 repository: anyOf: - type: 'null' - - *832 + - *834 sender: *4 required: - action @@ -172538,11 +172729,11 @@ webhooks: type: string required: - from - enterprise: *829 - installation: *830 - organization: *831 - project_column: *874 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + project_column: *876 + repository: *834 sender: *4 required: - action @@ -172622,11 +172813,11 @@ webhooks: type: string enum: - moved - enterprise: *829 - installation: *830 - organization: *831 - project_column: *874 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + project_column: *876 + repository: *834 sender: *4 required: - action @@ -172706,11 +172897,11 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - project: *875 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + project: *877 + repository: *834 sender: *4 required: - action @@ -172790,14 +172981,14 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - organization: *831 - project: *875 + enterprise: *831 + installation: *832 + organization: *833 + project: *877 repository: anyOf: - type: 'null' - - *832 + - *834 sender: *4 required: - action @@ -172898,11 +173089,11 @@ webhooks: type: string required: - from - enterprise: *829 - installation: *830 - organization: *831 - project: *875 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + project: *877 + repository: *834 sender: *4 required: - action @@ -172981,11 +173172,11 @@ webhooks: type: string enum: - reopened - enterprise: *829 - installation: *830 - organization: *831 - project: *875 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + project: *877 + repository: *834 sender: *4 required: - action @@ -173066,9 +173257,9 @@ webhooks: type: string enum: - closed - installation: *830 - organization: *831 - projects_v2: *383 + installation: *832 + organization: *833 + projects_v2: *386 sender: *4 required: - action @@ -173149,9 +173340,9 @@ webhooks: type: string enum: - created - installation: *830 - organization: *831 - projects_v2: *383 + installation: *832 + organization: *833 + projects_v2: *386 sender: *4 required: - action @@ -173232,9 +173423,9 @@ webhooks: type: string enum: - deleted - installation: *830 - organization: *831 - projects_v2: *383 + installation: *832 + organization: *833 + projects_v2: *386 sender: *4 required: - action @@ -173355,9 +173546,9 @@ webhooks: type: string to: type: string - installation: *830 - organization: *831 - projects_v2: *383 + installation: *832 + organization: *833 + projects_v2: *386 sender: *4 required: - action @@ -173440,7 +173631,7 @@ webhooks: type: string enum: - archived - changes: &879 + changes: &881 type: object properties: archived_at: @@ -173456,9 +173647,9 @@ webhooks: - string - 'null' format: date-time - installation: *830 - organization: *831 - projects_v2_item: &876 + installation: *832 + organization: *833 + projects_v2_item: &878 title: Projects v2 Item description: An item belonging to a project type: object @@ -173476,7 +173667,7 @@ webhooks: type: string description: The node ID of the content represented by this item. - content_type: *389 + content_type: *392 creator: *4 created_at: type: string @@ -173598,9 +173789,9 @@ webhooks: - 'null' to: type: string - installation: *830 - organization: *831 - projects_v2_item: *876 + installation: *832 + organization: *833 + projects_v2_item: *878 sender: *4 required: - action @@ -173682,9 +173873,9 @@ webhooks: type: string enum: - created - installation: *830 - organization: *831 - projects_v2_item: *876 + installation: *832 + organization: *833 + projects_v2_item: *878 sender: *4 required: - action @@ -173765,9 +173956,9 @@ webhooks: type: string enum: - deleted - installation: *830 - organization: *831 - projects_v2_item: *876 + installation: *832 + organization: *833 + projects_v2_item: *878 sender: *4 required: - action @@ -173872,7 +174063,7 @@ webhooks: oneOf: - type: string - type: integer - - &877 + - &879 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -173896,7 +174087,7 @@ webhooks: required: - id - name - - &878 + - &880 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -173936,8 +174127,8 @@ webhooks: oneOf: - type: string - type: integer - - *877 - - *878 + - *879 + - *880 type: - 'null' - string @@ -173960,9 +174151,9 @@ webhooks: - 'null' required: - body - installation: *830 - organization: *831 - projects_v2_item: *876 + installation: *832 + organization: *833 + projects_v2_item: *878 sender: *4 required: - action @@ -174059,9 +174250,9 @@ webhooks: type: - string - 'null' - installation: *830 - organization: *831 - projects_v2_item: *876 + installation: *832 + organization: *833 + projects_v2_item: *878 sender: *4 required: - action @@ -174144,10 +174335,10 @@ webhooks: type: string enum: - restored - changes: *879 - installation: *830 - organization: *831 - projects_v2_item: *876 + changes: *881 + installation: *832 + organization: *833 + projects_v2_item: *878 sender: *4 required: - action @@ -174229,9 +174420,9 @@ webhooks: type: string enum: - reopened - installation: *830 - organization: *831 - projects_v2: *383 + installation: *832 + organization: *833 + projects_v2: *386 sender: *4 required: - action @@ -174312,9 +174503,9 @@ webhooks: type: string enum: - created - installation: *830 - organization: *831 - projects_v2_status_update: *880 + installation: *832 + organization: *833 + projects_v2_status_update: *882 sender: *4 required: - action @@ -174395,9 +174586,9 @@ webhooks: type: string enum: - deleted - installation: *830 - organization: *831 - projects_v2_status_update: *880 + installation: *832 + organization: *833 + projects_v2_status_update: *882 sender: *4 required: - action @@ -174543,9 +174734,9 @@ webhooks: - string - 'null' format: date - installation: *830 - organization: *831 - projects_v2_status_update: *880 + installation: *832 + organization: *833 + projects_v2_status_update: *882 sender: *4 required: - action @@ -174616,10 +174807,10 @@ webhooks: title: public event type: object properties: - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - repository @@ -174696,13 +174887,13 @@ webhooks: type: string enum: - assigned - assignee: *856 - enterprise: *829 - installation: *830 - number: &881 + assignee: *858 + enterprise: *831 + installation: *832 + number: &883 description: The pull request number. type: integer - organization: *831 + organization: *833 pull_request: title: Pull Request type: object @@ -177051,7 +177242,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 sender: *4 required: - action @@ -177133,11 +177324,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 number: type: integer - organization: *831 + organization: *833 pull_request: title: Pull Request type: object @@ -179479,7 +179670,7 @@ webhooks: - draft reason: type: string - repository: *832 + repository: *834 sender: *4 required: - action @@ -179561,11 +179752,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 number: type: integer - organization: *831 + organization: *833 pull_request: title: Pull Request type: object @@ -181907,7 +182098,7 @@ webhooks: - draft reason: type: string - repository: *832 + repository: *834 sender: *4 required: - action @@ -181989,13 +182180,13 @@ webhooks: type: string enum: - closed - enterprise: *829 - installation: *830 - number: *881 - organization: *831 - pull_request: &882 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 + pull_request: &884 allOf: - - *680 + - *682 - type: object properties: allow_auto_merge: @@ -182057,7 +182248,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *832 + repository: *834 sender: *4 required: - action @@ -182138,12 +182329,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *829 - installation: *830 - number: *881 - organization: *831 - pull_request: *882 - repository: *832 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 + pull_request: *884 + repository: *834 sender: *4 required: - action @@ -182223,11 +182414,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *829 - milestone: *387 - number: *881 - organization: *831 - pull_request: &883 + enterprise: *831 + milestone: *390 + number: *883 + organization: *833 + pull_request: &885 title: Pull Request type: object properties: @@ -184554,7 +184745,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 sender: *4 required: - action @@ -184633,11 +184824,11 @@ webhooks: type: string enum: - dequeued - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 number: type: integer - organization: *831 + organization: *833 pull_request: title: Pull Request type: object @@ -186983,7 +187174,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *832 + repository: *834 sender: *4 required: - action @@ -187107,12 +187298,12 @@ webhooks: type: string required: - from - enterprise: *829 - installation: *830 - number: *881 - organization: *831 - pull_request: *882 - repository: *832 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 + pull_request: *884 + repository: *834 sender: *4 required: - action @@ -187192,11 +187383,11 @@ webhooks: type: string enum: - enqueued - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 number: type: integer - organization: *831 + organization: *833 pull_request: title: Pull Request type: object @@ -189527,7 +189718,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 sender: *4 required: - action @@ -189607,11 +189798,11 @@ webhooks: type: string enum: - labeled - enterprise: *829 - installation: *830 - label: *855 - number: *881 - organization: *831 + enterprise: *831 + installation: *832 + label: *857 + number: *883 + organization: *833 pull_request: title: Pull Request type: object @@ -191959,7 +192150,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 sender: *4 required: - action @@ -192040,10 +192231,10 @@ webhooks: type: string enum: - locked - enterprise: *829 - installation: *830 - number: *881 - organization: *831 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 pull_request: title: Pull Request type: object @@ -194389,7 +194580,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 sender: *4 required: - action @@ -194469,12 +194660,12 @@ webhooks: type: string enum: - milestoned - enterprise: *829 - milestone: *387 - number: *881 - organization: *831 - pull_request: *883 - repository: *832 + enterprise: *831 + milestone: *390 + number: *883 + organization: *833 + pull_request: *885 + repository: *834 sender: *4 required: - action @@ -194553,12 +194744,12 @@ webhooks: type: string enum: - opened - enterprise: *829 - installation: *830 - number: *881 - organization: *831 - pull_request: *882 - repository: *832 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 + pull_request: *884 + repository: *834 sender: *4 required: - action @@ -194639,12 +194830,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *829 - installation: *830 - number: *881 - organization: *831 - pull_request: *882 - repository: *832 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 + pull_request: *884 + repository: *834 sender: *4 required: - action @@ -194724,12 +194915,12 @@ webhooks: type: string enum: - reopened - enterprise: *829 - installation: *830 - number: *881 - organization: *831 - pull_request: *882 - repository: *832 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 + pull_request: *884 + repository: *834 sender: *4 required: - action @@ -195104,9 +195295,9 @@ webhooks: - start_side - side - reactions - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 pull_request: type: object properties: @@ -197336,7 +197527,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *832 + repository: *834 sender: *4 required: - action @@ -197416,7 +197607,7 @@ webhooks: type: string enum: - deleted - comment: &885 + comment: &887 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. @@ -197709,9 +197900,9 @@ webhooks: - start_side - side - reactions - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 pull_request: type: object properties: @@ -199929,7 +200120,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *832 + repository: *834 sender: *4 required: - action @@ -200009,11 +200200,11 @@ webhooks: type: string enum: - edited - changes: *884 - comment: *885 - enterprise: *829 - installation: *830 - organization: *831 + changes: *886 + comment: *887 + enterprise: *831 + installation: *832 + organization: *833 pull_request: type: object properties: @@ -202234,7 +202425,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *832 + repository: *834 sender: *4 required: - action @@ -202315,9 +202506,9 @@ webhooks: type: string enum: - dismissed - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 pull_request: title: Simple Pull Request type: object @@ -204550,7 +204741,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *832 + repository: *834 review: description: The review that was affected. type: object @@ -204801,9 +204992,9 @@ webhooks: type: string required: - from - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 pull_request: title: Simple Pull Request type: object @@ -206917,8 +207108,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *832 - review: &886 + repository: *834 + review: &888 description: The review that was affected. type: object properties: @@ -207156,12 +207347,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 number: description: The pull request number. type: integer - organization: *831 + organization: *833 pull_request: title: Pull Request type: object @@ -209508,7 +209699,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 requested_reviewer: title: User type: @@ -209594,12 +209785,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 number: description: The pull request number. type: integer - organization: *831 + organization: *833 pull_request: title: Pull Request type: object @@ -211953,7 +212144,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 requested_team: title: Team description: Groups of organization members that gives permissions @@ -212148,12 +212339,12 @@ webhooks: type: string enum: - review_requested - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 number: description: The pull request number. type: integer - organization: *831 + organization: *833 pull_request: title: Pull Request type: object @@ -214502,7 +214693,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 requested_reviewer: title: User type: @@ -214589,12 +214780,12 @@ webhooks: type: string enum: - review_requested - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 number: description: The pull request number. type: integer - organization: *831 + organization: *833 pull_request: title: Pull Request type: object @@ -216934,7 +217125,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 requested_team: title: Team description: Groups of organization members that gives permissions @@ -217118,9 +217309,9 @@ webhooks: type: string enum: - submitted - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 pull_request: title: Simple Pull Request type: object @@ -219356,8 +219547,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *832 - review: *886 + repository: *834 + review: *888 sender: *4 required: - action @@ -219437,9 +219628,9 @@ webhooks: type: string enum: - resolved - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 pull_request: title: Simple Pull Request type: object @@ -221570,7 +221761,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *832 + repository: *834 sender: *4 thread: type: object @@ -221967,9 +222158,9 @@ webhooks: type: string enum: - unresolved - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 pull_request: title: Simple Pull Request type: object @@ -224083,7 +224274,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *832 + repository: *834 sender: *4 thread: type: object @@ -224482,10 +224673,10 @@ webhooks: type: string before: type: string - enterprise: *829 - installation: *830 - number: *881 - organization: *831 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 pull_request: title: Pull Request type: object @@ -226820,7 +227011,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 sender: *4 required: - action @@ -226902,11 +227093,11 @@ webhooks: type: string enum: - unassigned - assignee: *887 - enterprise: *829 - installation: *830 - number: *881 - organization: *831 + assignee: *889 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 pull_request: title: Pull Request type: object @@ -229256,7 +229447,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 sender: *4 required: - action @@ -229335,11 +229526,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *829 - installation: *830 - label: *855 - number: *881 - organization: *831 + enterprise: *831 + installation: *832 + label: *857 + number: *883 + organization: *833 pull_request: title: Pull Request type: object @@ -231678,7 +231869,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 sender: *4 required: - action @@ -231759,10 +231950,10 @@ webhooks: type: string enum: - unlocked - enterprise: *829 - installation: *830 - number: *881 - organization: *831 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 pull_request: title: Pull Request type: object @@ -234091,7 +234282,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 sender: *4 required: - action @@ -234294,7 +234485,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *829 + enterprise: *831 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -234389,8 +234580,8 @@ webhooks: - url - author - committer - installation: *830 - organization: *831 + installation: *832 + organization: *833 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -234978,9 +235169,9 @@ webhooks: type: string enum: - published - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 registry_package: type: object properties: @@ -235457,7 +235648,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *870 + items: *872 summary: type: string tag_name: @@ -235513,7 +235704,7 @@ webhooks: - owner - package_version - registry - repository: *832 + repository: *834 sender: *4 required: - action @@ -235591,9 +235782,9 @@ webhooks: type: string enum: - updated - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 registry_package: type: object properties: @@ -235905,7 +236096,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *870 + items: *872 summary: type: string tag_name: @@ -235955,7 +236146,7 @@ webhooks: - owner - package_version - registry - repository: *832 + repository: *834 sender: *4 required: - action @@ -236032,10 +236223,10 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - release: &888 + enterprise: *831 + installation: *832 + organization: *833 + release: &890 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -236366,7 +236557,7 @@ webhooks: - updated_at - zipball_url - body - repository: *832 + repository: *834 sender: *4 required: - action @@ -236443,11 +236634,11 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - organization: *831 - release: *888 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + release: *890 + repository: *834 sender: *4 required: - action @@ -236564,11 +236755,11 @@ webhooks: type: boolean required: - to - enterprise: *829 - installation: *830 - organization: *831 - release: *888 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + release: *890 + repository: *834 sender: *4 required: - action @@ -236646,9 +236837,9 @@ webhooks: type: string enum: - prereleased - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -236984,7 +237175,7 @@ webhooks: - string - 'null' format: uri - repository: *832 + repository: *834 sender: *4 required: - action @@ -237060,10 +237251,10 @@ webhooks: type: string enum: - published - enterprise: *829 - installation: *830 - organization: *831 - release: &889 + enterprise: *831 + installation: *832 + organization: *833 + release: &891 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -237396,7 +237587,7 @@ webhooks: - string - 'null' format: uri - repository: *832 + repository: *834 sender: *4 required: - action @@ -237472,11 +237663,11 @@ webhooks: type: string enum: - released - enterprise: *829 - installation: *830 - organization: *831 - release: *888 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + release: *890 + repository: *834 sender: *4 required: - action @@ -237552,11 +237743,11 @@ webhooks: type: string enum: - unpublished - enterprise: *829 - installation: *830 - organization: *831 - release: *889 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + release: *891 + repository: *834 sender: *4 required: - action @@ -237632,11 +237823,11 @@ webhooks: type: string enum: - published - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - repository_advisory: *733 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + repository_advisory: *735 sender: *4 required: - action @@ -237712,11 +237903,11 @@ webhooks: type: string enum: - reported - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - repository_advisory: *733 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + repository_advisory: *735 sender: *4 required: - action @@ -237792,10 +237983,10 @@ webhooks: type: string enum: - archived - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -237872,10 +238063,10 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -237953,10 +238144,10 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -238041,10 +238232,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -238159,10 +238350,10 @@ webhooks: - 'null' items: type: string - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -238234,10 +238425,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 status: type: string @@ -238318,10 +238509,10 @@ webhooks: type: string enum: - privatized - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -238398,10 +238589,10 @@ webhooks: type: string enum: - publicized - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -238495,10 +238686,10 @@ webhooks: - name required: - repository - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -238578,10 +238769,10 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 repository_ruleset: *179 sender: *4 required: @@ -238660,10 +238851,10 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 repository_ruleset: *179 sender: *4 required: @@ -238742,10 +238933,10 @@ webhooks: type: string enum: - edited - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 repository_ruleset: *179 changes: type: object @@ -238807,16 +238998,16 @@ webhooks: properties: added: type: array - items: *701 + items: *703 deleted: type: array - items: *701 + items: *703 updated: type: array items: type: object properties: - rule: *701 + rule: *703 changes: type: object properties: @@ -239053,10 +239244,10 @@ webhooks: - from required: - owner - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -239134,10 +239325,10 @@ webhooks: type: string enum: - unarchived - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -239215,7 +239406,7 @@ webhooks: type: string enum: - create - alert: &890 + alert: &892 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -239339,10 +239530,10 @@ webhooks: type: string enum: - open - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -239552,10 +239743,10 @@ webhooks: type: string enum: - dismissed - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -239633,11 +239824,11 @@ webhooks: type: string enum: - reopen - alert: *890 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + alert: *892 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -239839,10 +240030,10 @@ webhooks: enum: - fixed - open - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -239920,7 +240111,7 @@ webhooks: type: string enum: - created - alert: &891 + alert: &893 type: object properties: number: *119 @@ -240034,10 +240225,10 @@ webhooks: anyOf: - type: 'null' - *4 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -240118,11 +240309,11 @@ webhooks: type: string enum: - created - alert: *891 - installation: *830 - location: *892 - organization: *831 - repository: *832 + alert: *893 + installation: *832 + location: *894 + organization: *833 + repository: *834 sender: *4 required: - location @@ -240360,11 +240551,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *891 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + alert: *893 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -240442,11 +240633,11 @@ webhooks: type: string enum: - reopened - alert: *891 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + alert: *893 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -240524,11 +240715,11 @@ webhooks: type: string enum: - resolved - alert: *891 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + alert: *893 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -240606,11 +240797,11 @@ webhooks: type: string enum: - validated - alert: *891 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + alert: *893 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -240740,10 +240931,10 @@ webhooks: - organization - enterprise - - repository: *832 - enterprise: *829 - installation: *830 - organization: *831 + repository: *834 + enterprise: *831 + installation: *832 + organization: *833 sender: *4 required: - action @@ -240821,11 +241012,11 @@ webhooks: type: string enum: - published - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - security_advisory: &893 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + security_advisory: &895 description: The details of the security advisory, including summary, description, and severity. type: object @@ -241011,11 +241202,11 @@ webhooks: type: string enum: - updated - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - security_advisory: *893 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + security_advisory: *895 sender: *4 required: - action @@ -241088,10 +241279,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -241277,11 +241468,11 @@ webhooks: from: type: object properties: - security_and_analysis: *395 - enterprise: *829 - installation: *830 - organization: *831 - repository: *461 + security_and_analysis: *398 + enterprise: *831 + installation: *832 + organization: *833 + repository: *462 sender: *4 required: - changes @@ -241359,12 +241550,12 @@ webhooks: type: string enum: - cancelled - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - sponsorship: &894 + sponsorship: &896 type: object properties: created_at: @@ -241669,12 +241860,12 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - sponsorship: *894 + sponsorship: *896 required: - action - sponsorship @@ -241762,12 +241953,12 @@ webhooks: type: string required: - from - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - sponsorship: *894 + sponsorship: *896 required: - action - changes @@ -241844,17 +242035,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &895 + effective_date: &897 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: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - sponsorship: *894 + sponsorship: *896 required: - action - sponsorship @@ -241928,7 +242119,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &896 + changes: &898 type: object properties: tier: @@ -241972,13 +242163,13 @@ webhooks: - from required: - tier - effective_date: *895 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + effective_date: *897 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - sponsorship: *894 + sponsorship: *896 required: - action - changes @@ -242055,13 +242246,13 @@ webhooks: type: string enum: - tier_changed - changes: *896 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + changes: *898 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - sponsorship: *894 + sponsorship: *896 required: - action - changes @@ -242135,10 +242326,10 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -242222,10 +242413,10 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -242659,15 +242850,15 @@ webhooks: type: - string - 'null' - enterprise: *829 + enterprise: *831 id: description: The unique identifier of the status. type: integer - installation: *830 + installation: *832 name: type: string - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 sha: description: The Commit SHA. @@ -242777,15 +242968,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *218 + parent_issue: *219 parent_issue_repo: *72 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *218 - installation: *830 - organization: *831 - repository: *832 + sub_issue: *219 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -242869,15 +243060,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *218 + parent_issue: *219 parent_issue_repo: *72 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *218 - installation: *830 - organization: *831 - repository: *832 + sub_issue: *219 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -242961,15 +243152,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *218 + sub_issue: *219 sub_issue_repo: *72 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *218 - installation: *830 - organization: *831 - repository: *832 + parent_issue: *219 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -243053,15 +243244,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *218 + sub_issue: *219 sub_issue_repo: *72 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *218 - installation: *830 - organization: *831 - repository: *832 + parent_issue: *219 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -243138,12 +243329,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - team: &897 + team: &899 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -243373,9 +243564,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 repository: title: Repository description: A git repository @@ -243845,7 +244036,7 @@ webhooks: - topics - visibility sender: *4 - team: *897 + team: *899 required: - action - team @@ -243921,9 +244112,9 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 repository: title: Repository description: A git repository @@ -244393,7 +244584,7 @@ webhooks: - topics - visibility sender: *4 - team: *897 + team: *899 required: - action - team @@ -244470,9 +244661,9 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 repository: title: Repository description: A git repository @@ -244942,7 +245133,7 @@ webhooks: - topics - visibility sender: *4 - team: *897 + team: *899 required: - action - team @@ -245086,9 +245277,9 @@ webhooks: - from required: - permissions - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 repository: title: Repository description: A git repository @@ -245558,7 +245749,7 @@ webhooks: - topics - visibility sender: *4 - team: *897 + team: *899 required: - action - changes @@ -245636,9 +245827,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 repository: title: Repository description: A git repository @@ -246108,7 +246299,7 @@ webhooks: - topics - visibility sender: *4 - team: *897 + team: *899 required: - action - team @@ -246184,10 +246375,10 @@ webhooks: type: string enum: - started - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -246260,17 +246451,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *829 + enterprise: *831 inputs: type: - object - 'null' additionalProperties: true - installation: *830 - organization: *831 + installation: *832 + organization: *833 ref: type: string - repository: *832 + repository: *834 sender: *4 workflow: type: string @@ -246352,10 +246543,10 @@ webhooks: type: string enum: - completed - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 workflow_job: allOf: @@ -246611,7 +246802,7 @@ webhooks: type: string required: - conclusion - deployment: *588 + deployment: *589 required: - action - repository @@ -246690,10 +246881,10 @@ webhooks: type: string enum: - in_progress - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 workflow_job: allOf: @@ -246975,7 +247166,7 @@ webhooks: required: - status - steps - deployment: *588 + deployment: *589 required: - action - repository @@ -247054,10 +247245,10 @@ webhooks: type: string enum: - queued - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 workflow_job: type: object @@ -247203,7 +247394,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *588 + deployment: *589 required: - action - repository @@ -247282,10 +247473,10 @@ webhooks: type: string enum: - waiting - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 workflow_job: type: object @@ -247432,7 +247623,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *588 + deployment: *589 required: - action - repository @@ -247512,12 +247703,12 @@ webhooks: type: string enum: - completed - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - workflow: *851 + workflow: *853 workflow_run: title: Workflow Run type: object @@ -248536,12 +248727,12 @@ webhooks: type: string enum: - in_progress - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - workflow: *851 + workflow: *853 workflow_run: title: Workflow Run type: object @@ -249545,12 +249736,12 @@ webhooks: type: string enum: - requested - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - workflow: *851 + workflow: *853 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 383c409a5..50c0b007a 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -66907,6 +66907,1849 @@ } } }, + "/enterprises/{enterprise}/settings/billing/budgets": { + "get": { + "summary": "Get all budgets", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all budgets for an enterprise. The authenticated user must be an enterprise admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-all-budgets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-all-budgets" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response when getting all budgets", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "budgets": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the budget", + "examples": [ + "2066deda-923f-43f9-88d2-62395a28c0cdd" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "SkuPricing", + "ProductPricing" + ], + "examples": [ + "SkuPricing" + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount limit in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "The type of limit enforcement for the budget", + "examples": [ + true + ] + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "examples": [ + "octocat/hello-world" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to." + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + }, + "required": [ + "will_alert", + "alert_recipients" + ] + } + }, + "required": [ + "id", + "budget_type", + "budget_product_sku", + "budget_scope", + "budget_amount", + "prevent_further_usage", + "budget_alerting" + ] + }, + "description": "Array of budget objects for the enterprise" + } + }, + "required": [ + "budgets" + ] + }, + "examples": { + "default": { + "value": { + "budgets": [ + { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "actions" + ], + "budget_scope": "enterprise", + "budget_amount": 1000.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "enterprise-admin", + "billing-manager" + ] + } + }, + { + "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", + "budget_type": "SkuPricing", + "budget_product_skus": [ + "actions_linux" + ], + "budget_scope": "organization", + "budget_amount": 500.0, + "prevent_further_usage": false, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "org-owner" + ] + } + }, + { + "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "packages" + ], + "budget_scope": "cost_center", + "budget_amount": 250.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + ] + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "post": { + "summary": "Create a budget", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "tags": [ + "billing" + ], + "operationId": "billing/create-budget", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#create-a-budget" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "budget_amount", + "prevent_further_usage", + "budget_alerting", + "budget_scope", + "budget_type" + ], + "properties": { + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "required": [ + "will_alert", + "alert_recipients" + ], + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "default": "" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + }, + "examples": { + "create-budget": { + "summary": "Create budget example", + "value": { + "budget_amount": 200, + "prevent_further_usage": true, + "budget_scope": "enterprise", + "budget_entity_name": "", + "budget_type": "ProductPricing", + "budget_product_sku": "actions", + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Budget created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the create operation" + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ], + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "examples": [ + "example-repository-name" + ] + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in dollars", + "minimum": 0.0, + "examples": [ + 100.0 + ] + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "examples": [ + true + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "examples": [ + "actions_linux" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ], + "examples": [ + "ProductPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + } + } + } + } + }, + "required": [ + "message", + "budget" + ] + }, + "examples": { + "create-budget": { + "value": { + "message": "Budget successfully created." + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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": "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": { + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#create-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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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 create budget.", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#create-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, + "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": { + "get": { + "summary": "Get a budget by ID", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a budget by ID. The authenticated user must be an enterprise admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-budget", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-a-budget-by-id" + }, + "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 updating a budget", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ], + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "examples": [ + "octocat/hello-world" + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "examples": [ + true + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "examples": [ + "actions_linux" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ], + "examples": [ + "ProductPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + } + } + }, + "required": [ + "id", + "budget_amount", + "prevent_further_usage", + "budget_product_sku", + "budget_type", + "budget_alerting", + "budget_scope", + "budget_entity_name" + ] + }, + "examples": { + "default": { + "value": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "patch": { + "summary": "Update a budget", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nUpdates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "tags": [ + "billing" + ], + "operationId": "billing/update-budget", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#update-a-budget" + }, + "parameters": [ + { + "name": "enterprise", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The slug version of the enterprise name" + }, + { + "name": "budget_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the budget" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + }, + "examples": { + "update-budget": { + "summary": "Update budget example", + "value": { + "prevent_further_usage": false, + "budget_amount": 10, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Budget updated successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the update operation" + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ], + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "examples": [ + "example-repository-name" + ] + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in dollars", + "minimum": 0.0, + "examples": [ + 100.0 + ] + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "examples": [ + true + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "examples": [ + "actions_linux" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ], + "examples": [ + "ProductPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + } + } + } + } + }, + "required": [ + "budget", + "message" + ] + }, + "examples": { + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "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/enhanced-billing#update-a-budget" + } + }, + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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/enterprise-admin/billing#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/enhanced-billing#update-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "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/enhanced-billing#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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, "/enterprises/{enterprise}/settings/billing/cost-centers": { "get": { "summary": "Get all cost centers for an enterprise", @@ -69672,7 +71515,7 @@ }, "/enterprises/{enterprise}/settings/billing/usage/summary": { "get": { - "summary": "Get billing usage summary report for an enterprise", + "summary": "Get billing usage summary for an enterprise", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default, this endpoint will return usage across all cost centers in the enterprise.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" @@ -69680,7 +71523,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-ghe", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-summary-report-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-summary-for-an-enterprise" }, "parameters": [ { @@ -69767,7 +71610,7 @@ ], "responses": { "200": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { @@ -108196,6 +110039,1320 @@ } } }, + "/organizations/{org}/settings/billing/budgets": { + "get": { + "summary": "Get all budgets for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all budgets for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-all-budgets-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-all-budgets-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 when getting all budgets", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "budgets": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the budget", + "examples": [ + "2066deda-923f-43f9-88d2-62395a28c0cdd" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "SkuPricing", + "ProductPricing" + ], + "examples": [ + "SkuPricing" + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount limit in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "The type of limit enforcement for the budget", + "examples": [ + true + ] + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "examples": [ + "octocat/hello-world" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to." + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + }, + "required": [ + "will_alert", + "alert_recipients" + ] + } + }, + "required": [ + "id", + "budget_type", + "budget_product_sku", + "budget_scope", + "budget_amount", + "prevent_further_usage", + "budget_alerting" + ] + }, + "description": "Array of budget objects for the enterprise" + } + }, + "required": [ + "budgets" + ] + }, + "examples": { + "default": { + "value": { + "budgets": [ + { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "actions" + ], + "budget_scope": "enterprise", + "budget_amount": 1000.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "enterprise-admin", + "billing-manager" + ] + } + }, + { + "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", + "budget_type": "SkuPricing", + "budget_product_skus": [ + "actions_linux" + ], + "budget_scope": "organization", + "budget_amount": 500.0, + "prevent_further_usage": false, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "org-owner" + ] + } + }, + { + "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "packages" + ], + "budget_scope": "cost_center", + "budget_amount": 250.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + ] + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, + "/organizations/{org}/settings/billing/budgets/{budget_id}": { + "get": { + "summary": "Get a budget by ID for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a budget by ID. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-a-budget-by-id-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "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 updating a budget", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ], + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "examples": [ + "octocat/hello-world" + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "examples": [ + true + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "examples": [ + "actions_linux" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ], + "examples": [ + "ProductPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + } + } + }, + "required": [ + "id", + "budget_amount", + "prevent_further_usage", + "budget_product_sku", + "budget_type", + "budget_alerting", + "budget_scope", + "budget_entity_name" + ] + }, + "examples": { + "default": { + "value": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "patch": { + "summary": "Update a budget for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nUpdates an existing budget for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/update-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#update-a-budget-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "budget_id", + "description": "The ID corresponding to the budget.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + }, + "examples": { + "update-budget": { + "summary": "Update budget example", + "value": { + "prevent_further_usage": false, + "budget_amount": 10, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Budget updated successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": [ + "Budget successfully updated." + ] + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "required": [ + "will_alert", + "alert_recipients" + ], + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "default": "" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + } + } + }, + "examples": { + "update-budget": { + "value": { + "message": "Budget successfully updated.", + "id": "550e8400-e29b-41d4-a716-446655440000" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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/enhanced-billing#update-a-budget" + } + }, + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#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", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "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 update budget.", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "delete": { + "summary": "Delete a budget for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/delete-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#delete-a-budget-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "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", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", @@ -108893,7 +112050,7 @@ }, "/organizations/{org}/settings/billing/usage/summary": { "get": { - "summary": "Get billing usage summary report for an organization", + "summary": "Get billing usage summary for an organization", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" @@ -108901,7 +112058,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-report-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-for-an-organization" }, "parameters": [ { @@ -108970,7 +112127,7 @@ ], "responses": { "200": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { @@ -201680,999 +204837,6 @@ } } }, - "/orgs/{org}/projects": { - "get": { - "summary": "List organization 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-organization-projects" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - } - }, - "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": true - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create an organization 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-an-organization-project" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the project." - }, - "body": { - "type": "string", - "description": "The description of the project." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "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" - } - } - } - } - } - }, - "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": "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/orgs/{org}/projectsV2": { "get": { "summary": "List projects for organization", @@ -265042,1125 +267206,6 @@ "deprecated": true } }, - "/projects/{project_id}": { - "get": { - "summary": "Get 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": [ - "projects-classic" - ], - "operationId": "projects-classic/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#get-a-project" - }, - "parameters": [ - { - "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": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "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": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update 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.", - "operationId": "projects-classic/update", - "tags": [ - "projects-classic" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#update-a-project" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone.", - "type": "boolean" - } - }, - "type": "object" - }, - "examples": { - "default": { - "summary": "Change the name, state, and permissions for a project", - "value": { - "name": "Week One Sprint", - "state": "open", - "organization_permission": "write" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "404": { - "description": "Not Found if the authenticated user does not have access to the project" - }, - "304": { - "description": "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": { - "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete 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.", - "operationId": "projects-classic/delete", - "tags": [ - "projects-classic" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#delete-a-project" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Delete Success" - }, - "304": { - "description": "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": { - "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/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": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/projects/{project_id}/collaborators": { "get": { "summary": "List project collaborators", @@ -541091,1421 +542136,77 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pages", - "subcategory": "pages" - } - } - }, - "/repos/{owner}/{repo}/private-vulnerability-reporting": { - "get": { - "summary": "Check if private vulnerability reporting is enabled for a repository", - "description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".", - "tags": [ - "repos" - ], - "operationId": "repos/check-private-vulnerability-reporting", - "externalDocs": { - "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": [ - { - "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": "Private vulnerability reporting status", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Whether or not private vulnerability reporting is enabled for the repository." - } - }, - "required": [ - "enabled" - ] - }, - "examples": { - "default": { - "value": { - "enabled": true - } - } - } - } - } - }, - "422": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" - } - }, - "put": { - "summary": "Enable private vulnerability reporting for a repository", - "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"", - "tags": [ - "repos" - ], - "operationId": "repos/enable-private-vulnerability-reporting", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-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": { - "204": { - "description": "A header with no content is returned." - }, - "422": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" - } - }, - "delete": { - "summary": "Disable private vulnerability reporting for a repository", - "description": "Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".", - "tags": [ - "repos" - ], - "operationId": "repos/disable-private-vulnerability-reporting", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-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": { - "204": { - "description": "A header with no content is returned." - }, - "422": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": [ - "string", - "null" - ] - }, - "documentation_url": { - "type": [ - "string", - "null" - ] - }, - "detail": { - "type": [ - "string", - "null" - ] - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": [ - "string", - "null" - ] - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" - } - } - }, - "/repos/{owner}/{repo}/projects": { - "get": { - "summary": "List repository 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-repository-projects" - }, - "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" - } - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "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": "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create a repository 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-a-repository-project" - }, - "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": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the project." - }, - "body": { - "type": "string", - "description": "The description of the project." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "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": "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": "pages", + "subcategory": "pages" + } + } + }, + "/repos/{owner}/{repo}/private-vulnerability-reporting": { + "get": { + "summary": "Check if private vulnerability reporting is enabled for a repository", + "description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".", + "tags": [ + "repos" + ], + "operationId": "repos/check-private-vulnerability-reporting", + "externalDocs": { + "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": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "410": { - "description": "Gone", + { + "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": "Private vulnerability reporting status", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether or not private vulnerability reporting is enabled for the repository." + } + }, + "required": [ + "enabled" + ] + }, + "examples": { + "default": { + "value": { + "enabled": true + } + } + } + } + } + }, + "422": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -542527,21 +542228,102 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + }, + "put": { + "summary": "Enable private vulnerability reporting for a repository", + "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"", + "tags": [ + "repos" + ], + "operationId": "repos/enable-private-vulnerability-reporting", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-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": { + "204": { + "description": "A header with no content is returned." }, "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "description": "Bad Request", "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -542549,7 +542331,49 @@ "documentation_url": { "type": "string" }, - "errors": { + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { "type": "array", "items": { "type": "string" @@ -542564,12 +542388,120 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" + "category": "repos", + "subcategory": "repos" + } + }, + "delete": { + "summary": "Disable private vulnerability reporting for a repository", + "description": "Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".", + "tags": [ + "repos" + ], + "operationId": "repos/disable-private-vulnerability-reporting", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository" }, - "deprecated": true + "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": { + "204": { + "description": "A header with no content is returned." + }, + "422": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } } }, "/repos/{owner}/{repo}/properties/values": { @@ -609901,8 +609833,12 @@ ] } }, - "required": [ - "state" + "anyOf": [ + { + "required": [ + "state" + ] + } ] }, "examples": { @@ -724159,498 +724095,6 @@ } } }, - "/user/projects": { - "post": { - "summary": "Create a user 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-a-user-project" - }, - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Create a new project", - "value": { - "name": "My Projects", - "body": "A board to manage my personal projects." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - } - } - } - } - }, - "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 Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/user/public_emails": { "get": { "summary": "List public email addresses for the authenticated user", @@ -761792,503 +761236,6 @@ } } }, - "/users/{username}/projects": { - "get": { - "summary": "List user 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-user-projects" - }, - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/users/{username}/projectsV2": { "get": { "summary": "List projects for user", @@ -789752,7 +788699,7 @@ }, "/users/{username}/settings/billing/usage/summary": { "get": { - "summary": "Get billing usage summary report for a user", + "summary": "Get billing usage summary for a user", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" @@ -789760,7 +788707,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-report-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-for-a-user" }, "parameters": [ { @@ -789829,7 +788776,7 @@ ], "responses": { "200": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index 6af65f838..8464d7796 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -915,7 +915,7 @@ paths: - subscriptions_url - type - url - type: &415 + type: &418 type: string description: The type of credit the user is receiving. enum: @@ -1048,7 +1048,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &245 + schema: &249 title: Validation Error Simple description: Validation Error Simple type: object @@ -1081,7 +1081,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &735 + - &737 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1666,7 +1666,7 @@ paths: schema: type: integer default: 30 - - &329 + - &333 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 @@ -1682,7 +1682,7 @@ paths: application/json: schema: type: array - items: &330 + items: &334 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1778,7 +1778,7 @@ paths: - installation_id - repository_id examples: - default: &331 + default: &335 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1810,7 +1810,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &745 + schema: &747 title: Scim Error description: Scim Error type: object @@ -1841,7 +1841,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &244 + schema: &248 title: Validation Error description: Validation Error type: object @@ -1913,7 +1913,7 @@ paths: description: Response content: application/json: - schema: &332 + schema: &336 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -2048,7 +2048,7 @@ paths: - request - response examples: - default: &333 + default: &337 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2252,7 +2252,7 @@ paths: parameters: - *17 - *19 - - &208 + - &209 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) @@ -3055,7 +3055,7 @@ paths: license: anyOf: - type: 'null' - - &219 + - &220 title: License Simple description: License Simple type: object @@ -7804,7 +7804,7 @@ paths: description: Response content: application/json: - schema: &246 + schema: &250 type: object properties: total_active_caches_count: @@ -7819,7 +7819,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &247 + default: &251 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -8034,7 +8034,7 @@ paths: - public_ip_enabled - platform examples: - default: &248 + default: &252 value: total_count: 2 runners: @@ -8338,7 +8338,7 @@ paths: application/json: schema: *43 examples: - default: &249 + default: &253 value: id: 1 platform: linux-x64 @@ -8483,7 +8483,7 @@ paths: application/json: schema: *46 examples: - default: &250 + default: &254 value: version: 1.0.0 size_gb: 75 @@ -8651,7 +8651,7 @@ paths: description: Response content: application/json: - schema: &251 + schema: &255 type: object properties: public_ips: @@ -8678,7 +8678,7 @@ paths: required: - public_ips examples: - default: &252 + default: &256 value: public_ips: current_usage: 17 @@ -8718,7 +8718,7 @@ paths: type: array items: *50 examples: - default: &253 + default: &257 value: id: 4-core cpu_cores: 4 @@ -8982,7 +8982,7 @@ paths: - all - local_only - selected - selected_actions_url: &256 + selected_actions_url: &260 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` @@ -9062,7 +9062,7 @@ paths: description: Successfully retrieved the artifact and log retention settings content: application/json: - schema: &258 + schema: &262 type: object properties: days: @@ -9080,7 +9080,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &746 + '401': &748 description: Authorization failure '404': *6 x-github: @@ -9108,7 +9108,7 @@ paths: required: true content: application/json: - schema: &259 + schema: &263 type: object properties: days: @@ -9157,7 +9157,7 @@ paths: required: - approval_policy examples: - default: &260 + default: &264 value: approval_policy: first_time_contributors '404': *6 @@ -9215,7 +9215,7 @@ paths: description: Response content: application/json: - schema: &261 + schema: &265 type: object required: - run_workflows_from_fork_pull_requests @@ -9269,7 +9269,7 @@ paths: required: true content: application/json: - schema: &262 + schema: &266 type: object required: - run_workflows_from_fork_pull_requests @@ -9705,7 +9705,7 @@ paths: description: Success response content: application/json: - schema: &265 + schema: &269 type: object properties: default_workflow_permissions: &61 @@ -9753,7 +9753,7 @@ paths: required: true content: application/json: - schema: &266 + schema: &270 type: object properties: default_workflow_permissions: *61 @@ -10598,7 +10598,7 @@ paths: application/json: schema: type: array - items: &270 + items: &274 title: Runner Application description: Runner Application type: object @@ -10623,7 +10623,7 @@ paths: - download_url - filename examples: - default: &271 + default: &275 value: - os: osx architecture: x64 @@ -10707,7 +10707,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &272 + '201': &276 description: Response content: application/json: @@ -10826,7 +10826,7 @@ paths: - token - expires_at examples: - default: &273 + default: &277 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -10866,7 +10866,7 @@ paths: application/json: schema: *73 examples: - default: &274 + default: &278 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -10898,7 +10898,7 @@ paths: application/json: schema: *70 examples: - default: &275 + default: &279 value: id: 23 name: MBP @@ -11114,7 +11114,7 @@ paths: - *39 - *69 responses: - '200': &276 + '200': &280 description: Response content: application/json: @@ -11170,7 +11170,7 @@ paths: parameters: - *39 - *69 - - &277 + - &281 name: name description: The name of a self-hosted runner's custom label. in: path @@ -11267,7 +11267,7 @@ paths: required: true content: application/json: - schema: &284 + schema: &288 title: Enterprise Announcement description: Enterprise global announcement type: object @@ -11918,7 +11918,7 @@ paths: required: false schema: type: string - - &285 + - &289 name: include description: |- The event types to include: @@ -11936,7 +11936,7 @@ paths: - web - git - all - - &286 + - &290 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. @@ -11944,7 +11944,7 @@ paths: required: false schema: type: string - - &287 + - &291 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. @@ -11952,7 +11952,7 @@ paths: required: false schema: type: string - - &288 + - &292 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -11974,7 +11974,7 @@ paths: application/json: schema: type: array - items: &289 + items: &293 type: object properties: "@timestamp": @@ -12096,7 +12096,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &290 + default: &294 value: - "@timestamp": 1606929874512 action: team.add_member @@ -12764,7 +12764,7 @@ paths: application/json: schema: type: array - items: &291 + items: &295 title: Push rule bypass request description: A bypass request made by a user asking to be exempted from a push rule in this repository. @@ -12936,7 +12936,7 @@ paths: examples: - https://github.com/octo-org/smile/exemptions/1 examples: - default: &292 + default: &296 value: - id: 21 number: 42 @@ -13041,7 +13041,7 @@ paths: application/json: schema: type: array - items: &294 + items: &298 title: Secret scanning bypass request description: A bypass request made by a user asking to be exempted from push protection in this repository. @@ -13172,7 +13172,7 @@ paths: examples: - https://github.com/octo-org/smile/exemptions/1 examples: - default: &295 + default: &299 value: - id: 21 number: 42 @@ -13257,7 +13257,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *39 - - &300 + - &304 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`, @@ -13267,7 +13267,7 @@ paths: schema: &105 type: string description: The name of the tool used to generate the code scanning analysis. - - &301 + - &305 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 @@ -13291,7 +13291,7 @@ paths: be returned. in: query required: false - schema: &302 + schema: &306 type: string description: State of a code scanning alert. enum: @@ -13316,7 +13316,7 @@ paths: application/json: schema: type: array - items: &303 + items: &307 type: object properties: number: &119 @@ -13345,7 +13345,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &528 + instances_url: &529 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -13381,7 +13381,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &529 + dismissed_reason: &530 type: - string - 'null' @@ -13392,14 +13392,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &530 + dismissed_comment: &531 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &531 + rule: &532 type: object properties: id: @@ -13460,7 +13460,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &532 + tool: &533 type: object properties: name: *105 @@ -13471,15 +13471,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *106 - most_recent_instance: &533 + most_recent_instance: &534 type: object properties: - ref: &526 + ref: &527 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &543 + analysis_key: &544 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -13490,7 +13490,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &544 + category: &545 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -13881,7 +13881,7 @@ paths: - most_recent_instance - repository examples: - default: &304 + default: &308 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -14540,7 +14540,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &305 + code_scanning_options: &309 type: - object - 'null' @@ -14738,7 +14738,7 @@ paths: description: Response content: application/json: - schema: &307 + schema: &311 type: array description: A list of default code security configurations items: @@ -14754,7 +14754,7 @@ paths: default configuration: *108 examples: - default: &308 + default: &312 value: - default_for_new_repos: public configuration: @@ -15208,7 +15208,7 @@ paths: default: value: default_for_new_repos: all - configuration: &306 + configuration: &310 value: id: 1325 target_type: organization @@ -15293,7 +15293,7 @@ paths: application/json: schema: type: array - items: &309 + items: &313 type: object description: Repositories associated with a code security configuration and attachment status @@ -15317,7 +15317,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &310 + repository: &314 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -15818,7 +15818,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &296 + - &300 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -15895,7 +15895,7 @@ paths: parent: anyOf: - type: 'null' - - &364 + - &368 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -16588,7 +16588,7 @@ paths: application/json: schema: type: array - items: &195 + items: &196 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -16903,7 +16903,7 @@ paths: - date additionalProperties: true examples: - default: &196 + default: &197 value: - date: '2024-06-24' total_active_users: 24 @@ -17005,7 +17005,7 @@ paths: '500': *38 '403': *27 '404': *6 - '422': &197 + '422': &198 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -17242,7 +17242,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *39 - - &316 + - &320 name: state in: query description: |- @@ -17251,7 +17251,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &317 + - &321 name: severity in: query description: |- @@ -17260,7 +17260,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &318 + - &322 name: ecosystem in: query description: |- @@ -17269,14 +17269,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &319 + - &323 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 - - &320 + - &324 name: epss_percentage in: query description: |- @@ -17288,7 +17288,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &579 + - &580 name: has in: query description: |- @@ -17302,7 +17302,7 @@ paths: type: string enum: - patch - - &321 + - &325 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -17312,7 +17312,7 @@ paths: enum: - development - runtime - - &322 + - &326 name: sort in: query description: |- @@ -17338,7 +17338,7 @@ paths: application/json: schema: type: array - items: &323 + items: &327 type: object description: A Dependabot alert. properties: @@ -17405,7 +17405,7 @@ paths: - direct - transitive - - security_advisory: &580 + security_advisory: &581 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -17641,7 +17641,7 @@ paths: dismissal. maxLength: 280 fixed_at: *129 - auto_dismissed_at: &581 + auto_dismissed_at: &582 type: - string - 'null' @@ -17668,7 +17668,7 @@ paths: - repository additionalProperties: false examples: - default: &324 + default: &328 value: - number: 2 state: dismissed @@ -18449,7 +18449,7 @@ paths: type: array items: *134 examples: - default: &198 + default: &199 value: - id: 1 name: Justice League @@ -18786,7 +18786,7 @@ paths: - name - created_on examples: - default: &425 + default: &428 value: total_count: 2 network_configurations: @@ -19009,7 +19009,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *39 - - &426 + - &429 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -19021,7 +19021,7 @@ paths: description: Response content: application/json: - schema: &427 + schema: &430 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -19060,7 +19060,7 @@ paths: - subnet_id - region examples: - default: &428 + default: &431 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -19894,7 +19894,7 @@ paths: required: true content: application/json: - schema: &394 + schema: &397 title: Custom Property Set Payload description: Custom property set payload type: object @@ -21023,7 +21023,7 @@ paths: conditions: anyOf: - *151 - - &398 + - &401 title: Organization ruleset conditions type: object description: |- @@ -21073,7 +21073,7 @@ paths: - object rules: type: array - items: &701 + items: &703 title: Repository Rule type: object description: A repository rule. @@ -21082,7 +21082,7 @@ paths: - *160 - *161 - *162 - - &698 + - &700 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -21176,7 +21176,7 @@ paths: - *176 - *177 - *178 - - &699 + - &701 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. @@ -21432,7 +21432,7 @@ paths: type: string format: date-time examples: - default: &401 + default: &404 value: - version_id: 3 actor: @@ -21485,7 +21485,7 @@ paths: description: Response content: application/json: - schema: &402 + schema: &405 allOf: - *183 - type: object @@ -21540,7 +21540,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *39 - - &403 + - &406 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -21551,7 +21551,7 @@ paths: enum: - open - resolved - - &404 + - &407 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -21561,7 +21561,7 @@ paths: required: false schema: type: string - - &405 + - &408 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -21570,7 +21570,7 @@ paths: required: false schema: type: string - - &406 + - &409 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. @@ -21586,7 +21586,7 @@ paths: - *17 - *102 - *103 - - &407 + - &410 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -21595,7 +21595,7 @@ paths: required: false schema: type: string - - &408 + - &411 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -21604,7 +21604,7 @@ paths: schema: type: boolean default: false - - &409 + - &412 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -21613,7 +21613,7 @@ paths: schema: type: boolean default: false - - &410 + - &413 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -21629,7 +21629,7 @@ paths: application/json: schema: type: array - items: &411 + items: &414 type: object properties: number: *119 @@ -21645,14 +21645,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &713 + state: &715 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: &714 + resolution: &716 type: - string - 'null' @@ -21759,14 +21759,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &715 + - &717 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &717 + - &719 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -21823,7 +21823,7 @@ paths: - blob_url - commit_sha - commit_url - - &718 + - &720 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. @@ -21884,7 +21884,7 @@ paths: - page_url - commit_sha - commit_url - - &719 + - &721 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -21899,7 +21899,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &720 + - &722 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -21914,7 +21914,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &721 + - &723 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -21929,7 +21929,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &722 + - &724 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -21944,7 +21944,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &723 + - &725 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -21959,7 +21959,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &724 + - &726 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -21974,7 +21974,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &725 + - &727 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. @@ -21989,7 +21989,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &726 + - &728 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. @@ -22004,7 +22004,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &727 + - &729 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. @@ -22019,7 +22019,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &728 + - &730 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. @@ -22034,7 +22034,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &729 + - &731 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 @@ -22059,7 +22059,7 @@ paths: - type: 'null' - *4 examples: - default: &412 + default: &415 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -22268,7 +22268,7 @@ paths: description: Response content: application/json: - schema: &413 + schema: &416 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -22355,7 +22355,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *185 examples: - default: &414 + default: &417 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -22499,7 +22499,7 @@ paths: description: Response content: application/json: - schema: &416 + schema: &419 type: object properties: total_minutes_used: @@ -22569,7 +22569,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &417 + default: &420 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -22600,7 +22600,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *39 - - &418 + - &421 name: advanced_security_product in: query description: | @@ -22620,7 +22620,7 @@ paths: description: Success content: application/json: - schema: &419 + schema: &422 type: object properties: total_advanced_security_committers: @@ -22683,7 +22683,7 @@ paths: required: - repositories examples: - default: &420 + default: &423 value: total_advanced_security_committers: 2 total_count: 2 @@ -22710,6 +22710,724 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: billing + "/enterprises/{enterprise}/settings/billing/budgets": + get: + summary: Get all budgets + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets all budgets for an enterprise. The authenticated user must be an enterprise admin or billing manager. + tags: + - billing + operationId: billing/get-all-budgets + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-all-budgets + parameters: + - *39 + responses: + '200': &236 + description: Response when getting all budgets + content: + application/json: + schema: + type: object + properties: + budgets: + type: array + items: + type: object + properties: + id: + type: string + description: The unique identifier for the budget + examples: + - 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: + type: string + description: The type of pricing for the budget + enum: + - SkuPricing + - ProductPricing + examples: + - SkuPricing + budget_amount: + type: integer + description: The budget amount limit in whole dollars. For + license-based products, this represents the number of + licenses. + prevent_further_usage: + type: boolean + description: The type of limit enforcement for the budget + examples: + - true + budget_scope: + type: string + description: The scope of the budget (enterprise, organization, + repository, cost center) + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity for the budget (enterprise + does not require a name). + examples: + - octocat/hello-world + budget_product_sku: + type: string + description: A single product or sku to apply the budget + to. + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + examples: + - mona + - lisa + required: + - will_alert + - alert_recipients + required: + - id + - budget_type + - budget_product_sku + - budget_scope + - budget_amount + - prevent_further_usage + - budget_alerting + description: Array of budget objects for the enterprise + required: + - budgets + examples: + default: + value: + budgets: + - id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_skus: + - actions + budget_scope: enterprise + budget_amount: 1000.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - enterprise-admin + - billing-manager + - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 + budget_type: SkuPricing + budget_product_skus: + - actions_linux + budget_scope: organization + budget_amount: 500.0 + prevent_further_usage: false + budget_alerting: + will_alert: true + alert_recipients: + - org-owner + - id: 6ba7b810-9dad-11d1-80b4-00c04fd430c8 + budget_type: ProductPricing + budget_product_skus: + - packages + budget_scope: cost_center + budget_amount: 250.0 + prevent_further_usage: true + budget_alerting: + will_alert: false + alert_recipients: [] + '404': *6 + '403': *27 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + post: + summary: Create a budget + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise. + tags: + - billing + operationId: billing/create-budget + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#create-a-budget + parameters: + - *39 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - budget_amount + - prevent_further_usage + - budget_alerting + - budget_scope + - budget_type + properties: + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + budget_alerting: + type: object + required: + - will_alert + - alert_recipients + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + default: '' + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered in the + budget + examples: + create-budget: + summary: Create budget example + value: + budget_amount: 200 + prevent_further_usage: true + budget_scope: enterprise + budget_entity_name: '' + budget_type: ProductPricing + budget_product_sku: actions + budget_alerting: + will_alert: false + alert_recipients: [] + responses: + '200': + description: Budget created successfully + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the result of the create operation + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + enum: + - enterprise + - organization + - repository + - cost_center + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + examples: + - example-repository-name + budget_amount: + type: number + format: float + description: The budget amount in dollars + minimum: 0.0 + examples: + - 100.0 + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the + budget is exceeded + examples: + - true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + examples: + - actions_linux + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + examples: + - ProductPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + examples: + - mona + - lisa + required: + - message + - budget + examples: + create-budget: + value: + message: Budget successfully created. + '400': *14 + '401': *23 + '403': *27 + '404': + description: Feature not enabled + content: + application/json: + schema: *3 + examples: + feature-not-enabled: + value: + message: Not Found + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#create-a-budget + '422': *15 + '500': + description: Internal server error + content: + application/json: + schema: *3 + examples: + server-error: + value: + message: Unable to create budget. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#create-a-budget + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": + get: + summary: Get a budget by ID + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager. + tags: + - billing + operationId: billing/get-budget + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-a-budget-by-id + parameters: + - *39 + - &187 + name: budget_id + description: The ID corresponding to the budget. + in: path + required: true + schema: + type: string + responses: + '200': &237 + description: Response when updating a budget + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + enum: + - enterprise + - organization + - repository + - cost_center + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + examples: + - octocat/hello-world + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + examples: + - true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + examples: + - actions_linux + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + examples: + - ProductPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + examples: + - mona + - lisa + required: + - id + - budget_amount + - prevent_further_usage + - budget_product_sku + - budget_type + - budget_alerting + - budget_scope + - budget_entity_name + examples: + default: + value: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa + '400': *14 + '404': *6 + '403': *27 + '500': *38 + '503': *184 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + patch: + summary: Update a budget + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise. + tags: + - billing + operationId: billing/update-budget + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#update-a-budget + parameters: + - name: enterprise + in: path + required: true + schema: + type: string + description: The slug version of the enterprise name + - name: budget_id + in: path + required: true + schema: + type: string + description: The unique identifier of the budget + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered in the + budget + examples: + update-budget: + summary: Update budget example + value: + prevent_further_usage: false + budget_amount: 10 + budget_alerting: + will_alert: false + alert_recipients: [] + responses: + '200': + description: Budget updated successfully + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the result of the update operation + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + enum: + - enterprise + - organization + - repository + - cost_center + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + examples: + - example-repository-name + budget_amount: + type: number + format: float + description: The budget amount in dollars + minimum: 0.0 + examples: + - 100.0 + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the + budget is exceeded + examples: + - true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + examples: + - actions_linux + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + examples: + - ProductPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + examples: + - mona + - lisa + required: + - budget + - message + examples: + update-budget: + value: + message: Budget successfully updated. + budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b + '400': *14 + '401': *23 + '403': *27 + '404': + description: Budget not found or feature not enabled + content: + application/json: + schema: *3 + examples: + budget-not-found: + value: + message: Budget with ID 550e8400-e29b-41d4-a716-446655440000 not + found. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + feature-not-enabled: + value: + message: Not Found + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + '422': *15 + '500': + description: Internal server error + content: + application/json: + schema: *3 + examples: + server-error: + value: + message: Unable to retrieve budget. + documentation_url: https://docs.github.com/rest/enterprise-admin/billing#update-a-budget + '503': + description: Service unavailable + content: + application/json: + schema: *3 + examples: + server-error: + value: + message: Unable to update budget. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + delete: + summary: Delete a budget + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Deletes 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/enhanced-billing#delete-a-budget + parameters: + - *39 + - *187 + responses: + '200': &238 + 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': *14 + '404': *6 + '403': *27 + '500': *38 + '503': *184 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing "/enterprises/{enterprise}/settings/billing/cost-centers": get: summary: Get all cost centers for an enterprise @@ -22934,7 +23652,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-a-cost-center-by-id parameters: - *39 - - &189 + - &190 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -22946,7 +23664,7 @@ paths: description: Response when getting a cost center content: application/json: - schema: &187 + schema: &188 type: object properties: id: @@ -22986,7 +23704,7 @@ paths: - name - resources examples: - default: &188 + default: &189 value: id: 2eeb8ffe-6903-11ee-8c99-0242ac120002 name: Cost Center Name @@ -23050,9 +23768,9 @@ paths: description: Response when updating a cost center content: application/json: - schema: *187 + schema: *188 examples: - default: *188 + default: *189 '400': *14 '403': *27 '404': *6 @@ -23076,7 +23794,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#delete-a-cost-center parameters: - *39 - - *189 + - *190 responses: '200': description: Response when deleting a cost center @@ -23136,7 +23854,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#add-resources-to-a-cost-center parameters: - *39 - - *189 + - *190 requestBody: required: true content: @@ -23229,7 +23947,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#remove-resources-from-a-cost-center parameters: - *39 - - *189 + - *190 requestBody: required: true content: @@ -23307,7 +24025,7 @@ paths: description: Response content: application/json: - schema: &421 + schema: &424 type: object properties: total_gigabytes_bandwidth_used: @@ -23325,7 +24043,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &422 + default: &425 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -23350,7 +24068,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-premium-request-usage-report-for-an-enterprise parameters: - *39 - - &190 + - &191 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, @@ -23359,7 +24077,7 @@ paths: required: false schema: type: integer - - &192 + - &193 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 @@ -23368,7 +24086,7 @@ paths: required: false schema: type: integer - - &191 + - &192 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 @@ -23377,7 +24095,7 @@ paths: required: false schema: type: integer - - &193 + - &194 name: organization description: The organization name to query usage for. The name is not case sensitive. @@ -23385,21 +24103,21 @@ paths: required: false schema: type: string - - &235 + - &239 name: user description: The user name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &236 + - &240 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &194 + - &195 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -23569,7 +24287,7 @@ paths: description: Response content: application/json: - schema: &423 + schema: &426 type: object properties: days_left_in_billing_cycle: @@ -23587,7 +24305,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &424 + default: &427 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -23612,8 +24330,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - *39 - - *190 - - &237 + - *191 + - &241 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 @@ -23622,7 +24340,7 @@ paths: required: false schema: type: integer - - *191 + - *192 - name: cost_center_id description: The ID corresponding to a cost center. The default value is no cost center. @@ -23635,7 +24353,7 @@ paths: description: Response when getting a billing usage report content: application/json: - schema: &238 + schema: &242 type: object properties: usageItems: @@ -23688,7 +24406,7 @@ paths: - netAmount - organizationName examples: - default: &239 + default: &243 value: usageItems: - date: '2023-08-01' @@ -23713,7 +24431,7 @@ paths: subcategory: billing "/enterprises/{enterprise}/settings/billing/usage/summary": get: - summary: Get billing usage summary report for an enterprise + summary: Get billing usage summary for an enterprise description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. @@ -23726,22 +24444,22 @@ paths: operationId: billing/get-github-billing-usage-summary-report-ghe externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-summary-report-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-summary-for-an-enterprise parameters: - *39 - - *190 - - *192 - *191 - *193 - - &240 + - *192 + - *194 + - &244 name: repository description: The repository name to query for usage in the format owner/repository. in: query required: false schema: type: string - - *194 - - &241 + - *195 + - &245 name: sku description: The SKU to query for usage. in: query @@ -23757,7 +24475,7 @@ paths: type: string responses: '200': - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -23940,13 +24658,13 @@ paths: application/json: schema: type: array - items: *195 + items: *196 examples: - default: *196 + default: *197 '500': *38 '403': *27 '404': *6 - '422': *197 + '422': *198 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -23975,7 +24693,7 @@ paths: type: array items: *134 examples: - default: *198 + default: *199 headers: Link: *41 '403': *27 @@ -24054,7 +24772,7 @@ paths: application/json: schema: *134 examples: - default: *198 + default: *199 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24072,7 +24790,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *39 - - &199 + - &200 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -24091,7 +24809,7 @@ paths: type: array items: *4 examples: - default: &200 + default: &201 value: - login: octocat id: 1 @@ -24130,7 +24848,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *39 - - *199 + - *200 requestBody: required: true content: @@ -24161,7 +24879,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24179,7 +24897,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *39 - - *199 + - *200 requestBody: required: true content: @@ -24210,7 +24928,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24228,7 +24946,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *39 - - *199 + - *200 - *132 responses: '200': @@ -24237,7 +24955,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &201 + exampleKey1: &202 value: login: octocat id: 1 @@ -24273,7 +24991,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *39 - - *199 + - *200 - *132 responses: '201': @@ -24282,7 +25000,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *201 + exampleKey1: *202 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24300,7 +25018,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *39 - - *199 + - *200 - *132 responses: '204': @@ -24323,7 +25041,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments parameters: - *39 - - *199 + - *200 - *17 - *19 responses: @@ -24335,7 +25053,7 @@ paths: type: array items: *67 examples: - default: &202 + default: &203 value: login: github id: 1 @@ -24366,7 +25084,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments parameters: - *39 - - *199 + - *200 requestBody: required: true content: @@ -24396,7 +25114,7 @@ paths: type: array items: *67 examples: - default: &234 + default: &235 value: - login: github id: 1 @@ -24427,7 +25145,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments parameters: - *39 - - *199 + - *200 requestBody: required: true content: @@ -24468,7 +25186,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment parameters: - *39 - - *199 + - *200 - *81 responses: '200': @@ -24477,7 +25195,7 @@ paths: application/json: schema: *67 examples: - default: *202 + default: *203 '404': description: The team is not assigned to the organization x-github: @@ -24496,7 +25214,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment parameters: - *39 - - *199 + - *200 - *81 responses: '201': @@ -24505,7 +25223,7 @@ paths: application/json: schema: *67 examples: - default: *202 + default: *203 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24522,7 +25240,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment parameters: - *39 - - *199 + - *200 - *81 responses: '204': @@ -24547,7 +25265,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *39 - - &203 + - &204 name: team_slug description: The slug of the team name. in: path @@ -24561,7 +25279,7 @@ paths: application/json: schema: *134 examples: - default: *198 + default: *199 headers: Link: *41 '403': *27 @@ -24581,7 +25299,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *39 - - *203 + - *204 requestBody: required: true content: @@ -24641,7 +25359,7 @@ paths: application/json: schema: *134 examples: - default: *198 + default: *199 headers: Link: *41 '403': *27 @@ -24664,7 +25382,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *39 - - *203 + - *204 responses: '204': description: Response @@ -24763,7 +25481,7 @@ paths: application/json: schema: type: array - items: &229 + items: &230 title: Event description: Event type: object @@ -24774,7 +25492,7 @@ paths: type: - string - 'null' - actor: &204 + actor: &205 title: Actor description: Actor type: object @@ -24815,13 +25533,13 @@ paths: - id - name - url - org: *204 + org: *205 payload: type: object properties: action: type: string - issue: &218 + issue: &219 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -24942,7 +25660,7 @@ paths: milestone: anyOf: - type: 'null' - - &387 + - &390 title: Milestone description: A collection of related issues and pull requests. @@ -25114,7 +25832,7 @@ paths: timeline_url: type: string format: uri - type: &351 + type: &355 title: Issue Type description: The type of issue. type: @@ -25172,7 +25890,7 @@ paths: anyOf: - type: 'null' - *5 - author_association: &205 + author_association: &206 title: author_association type: string description: How the author is associated with the repository. @@ -25187,7 +25905,7 @@ paths: - OWNER examples: - OWNER - reactions: &206 + reactions: &207 title: Reaction Rollup type: object properties: @@ -25223,7 +25941,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &773 + sub_issues_summary: &775 title: Sub-issues Summary type: object properties: @@ -25244,7 +25962,7 @@ paths: - string - 'null' format: uri - issue_dependencies_summary: &774 + issue_dependencies_summary: &776 title: Issue Dependencies Summary type: object properties: @@ -25263,7 +25981,7 @@ paths: - total_blocking issue_field_values: type: array - items: &775 + items: &777 title: Issue Field Value description: A value assigned to an issue field type: object @@ -25358,7 +26076,7 @@ paths: - user - created_at - updated_at - comment: &636 + comment: &638 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -25408,12 +26126,12 @@ paths: issue_url: type: string format: uri - author_association: *205 + author_association: *206 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *206 + reactions: *207 required: - id - node_id @@ -25591,7 +26309,7 @@ paths: _links: type: object properties: - timeline: &207 + timeline: &208 title: Link With Type description: Hypermedia Link with Type type: object @@ -25603,17 +26321,17 @@ paths: required: - href - type - user: *207 - security_advisories: *207 - current_user: *207 - current_user_public: *207 - current_user_actor: *207 - current_user_organization: *207 + user: *208 + security_advisories: *208 + current_user: *208 + current_user_public: *208 + current_user_actor: *208 + current_user_organization: *208 current_user_organizations: type: array - items: *207 - repository_discussions: *207 - repository_discussions_category: *207 + items: *208 + repository_discussions: *208 + repository_discussions_category: *208 required: - timeline - user @@ -25675,7 +26393,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *208 + - *209 - *17 - *19 responses: @@ -25685,7 +26403,7 @@ paths: application/json: schema: type: array - items: &209 + items: &210 title: Base Gist description: Base Gist type: object @@ -25782,7 +26500,7 @@ paths: - created_at - updated_at examples: - default: &210 + default: &211 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -25906,7 +26624,7 @@ paths: description: Response content: application/json: - schema: &211 + schema: &212 title: Gist Simple description: Gist Simple type: object @@ -25924,7 +26642,7 @@ paths: url: type: string format: uri - user: &787 + user: &789 title: Public User description: Public User type: object @@ -26298,7 +27016,7 @@ paths: truncated: type: boolean examples: - default: &212 + default: &213 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -26402,7 +27120,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *208 + - *209 - *17 - *19 responses: @@ -26412,9 +27130,9 @@ paths: application/json: schema: type: array - items: *209 + items: *210 examples: - default: *210 + default: *211 headers: Link: *41 '422': *15 @@ -26436,7 +27154,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *208 + - *209 - *17 - *19 responses: @@ -26446,9 +27164,9 @@ paths: application/json: schema: type: array - items: *209 + items: *210 examples: - default: *210 + default: *211 headers: Link: *41 '401': *23 @@ -26476,7 +27194,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &213 + - &214 name: gist_id description: The unique identifier of the gist. in: path @@ -26488,10 +27206,10 @@ paths: description: Response content: application/json: - schema: *211 + schema: *212 examples: - default: *212 - '403': &216 + default: *213 + '403': &217 description: Forbidden Gist content: application/json: @@ -26540,7 +27258,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *213 + - *214 requestBody: required: true content: @@ -26604,9 +27322,9 @@ paths: description: Response content: application/json: - schema: *211 + schema: *212 examples: - updateGist: *212 + updateGist: *213 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -26764,7 +27482,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *213 + - *214 responses: '204': description: Response @@ -26793,7 +27511,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *213 + - *214 - *17 - *19 responses: @@ -26803,7 +27521,7 @@ paths: application/json: schema: type: array - items: &214 + items: &215 title: Gist Comment description: A comment made to a gist. type: object @@ -26841,7 +27559,7 @@ paths: format: date-time examples: - '2011-04-18T23:23:56Z' - author_association: *205 + author_association: *206 required: - url - id @@ -26906,7 +27624,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *213 + - *214 requestBody: required: true content: @@ -26932,9 +27650,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *215 examples: - default: &215 + default: &216 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -26992,8 +27710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *213 - - &217 + - *214 + - &218 name: comment_id description: The unique identifier of the comment. in: path @@ -27006,12 +27724,12 @@ paths: description: Response content: application/json: - schema: *214 + schema: *215 examples: - default: *215 + default: *216 '304': *35 '404': *6 - '403': *216 + '403': *217 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27033,8 +27751,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *213 - - *217 + - *214 + - *218 requestBody: required: true content: @@ -27060,9 +27778,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *215 examples: - default: *215 + default: *216 '404': *6 x-github: githubCloudOnly: false @@ -27079,8 +27797,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *213 - - *217 + - *214 + - *218 responses: '204': description: Response @@ -27103,7 +27821,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *213 + - *214 - *17 - *19 responses: @@ -27204,7 +27922,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *213 + - *214 - *17 - *19 responses: @@ -27214,7 +27932,7 @@ paths: application/json: schema: type: array - items: *211 + items: *212 examples: default: value: @@ -27279,13 +27997,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *213 + - *214 responses: '201': description: Response content: application/json: - schema: *209 + schema: *210 examples: default: value: @@ -27356,7 +28074,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *213 + - *214 responses: '204': description: Response if gist is starred @@ -27386,7 +28104,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *213 + - *214 responses: '204': description: Response @@ -27408,7 +28126,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *213 + - *214 responses: '204': description: Response @@ -27437,7 +28155,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *213 + - *214 - name: sha in: path required: true @@ -27448,9 +28166,9 @@ paths: description: Response content: application/json: - schema: *211 + schema: *212 examples: - default: *212 + default: *213 '422': *15 '404': *6 '403': *27 @@ -27819,7 +28537,7 @@ paths: - closed - all default: open - - &354 + - &358 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -27838,7 +28556,7 @@ paths: - comments default: created - *104 - - *208 + - *209 - name: collab in: query required: false @@ -27868,9 +28586,9 @@ paths: application/json: schema: type: array - items: *218 + items: *219 examples: - default: &355 + default: &359 value: - id: 1 node_id: MDU6SXNzdWUx @@ -28150,7 +28868,7 @@ paths: application/json: schema: type: array - items: *219 + items: *220 examples: default: value: @@ -28448,7 +29166,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &220 + X-CommonMarker-Version: &221 example: 0.17.4 schema: type: string @@ -28503,7 +29221,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *220 + X-CommonMarker-Version: *221 content: text/html: schema: @@ -28532,7 +29250,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: - - &223 + - &224 name: account_id description: account_id parameter in: path @@ -28544,7 +29262,7 @@ paths: description: Response content: application/json: - schema: &222 + schema: &223 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -28578,7 +29296,7 @@ paths: - 'null' id: type: integer - plan: &221 + plan: &222 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -28681,7 +29399,7 @@ paths: - 'null' updated_at: type: string - plan: *221 + plan: *222 required: - url - id @@ -28689,7 +29407,7 @@ paths: - login - marketplace_purchase examples: - default: &224 + default: &225 value: url: https://api.github.com/orgs/github type: Organization @@ -28774,9 +29492,9 @@ paths: application/json: schema: type: array - items: *221 + items: *222 examples: - default: &225 + default: &226 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -28816,14 +29534,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &226 + - &227 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &227 + - &228 name: sort description: The property to sort the results by. in: query @@ -28853,9 +29571,9 @@ paths: application/json: schema: type: array - items: *222 + items: *223 examples: - default: &228 + default: &229 value: - url: https://api.github.com/orgs/github type: Organization @@ -28929,15 +29647,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: - - *223 + - *224 responses: '200': description: Response content: application/json: - schema: *222 + schema: *223 examples: - default: *224 + default: *225 '404': description: Not Found when the account has not purchased the listing '401': *23 @@ -28969,9 +29687,9 @@ paths: application/json: schema: type: array - items: *221 + items: *222 examples: - default: *225 + default: *226 headers: Link: *41 '401': *23 @@ -28994,8 +29712,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *226 - *227 + - *228 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -29015,9 +29733,9 @@ paths: application/json: schema: type: array - items: *222 + items: *223 examples: - default: *228 + default: *229 headers: Link: *41 '401': *23 @@ -29282,14 +30000,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: - - &448 + - &451 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &449 + - &452 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -29306,7 +30024,7 @@ paths: application/json: schema: type: array - items: *229 + items: *230 examples: default: value: @@ -29351,7 +30069,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &462 + '301': &463 description: Moved permanently content: application/json: @@ -29373,7 +30091,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &665 + - &667 name: all description: If `true`, show notifications marked as read. in: query @@ -29381,7 +30099,7 @@ paths: schema: type: boolean default: false - - &666 + - &668 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -29390,8 +30108,8 @@ paths: schema: type: boolean default: false - - *208 - - &667 + - *209 + - &669 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: @@ -29416,14 +30134,14 @@ paths: application/json: schema: type: array - items: &230 + items: &231 title: Thread description: Thread type: object properties: id: type: string - repository: &269 + repository: &273 title: Minimal Repository description: Minimal Repository type: object @@ -29762,7 +30480,7 @@ paths: type: boolean examples: - false - security_and_analysis: &395 + security_and_analysis: &398 type: - object - 'null' @@ -29935,7 +30653,7 @@ paths: - url - subscription_url examples: - default: &668 + default: &670 value: - id: '1' repository: @@ -30101,7 +30819,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &231 + - &232 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 @@ -30115,7 +30833,7 @@ paths: description: Response content: application/json: - schema: *230 + schema: *231 examples: default: value: @@ -30218,7 +30936,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *231 + - *232 responses: '205': description: Reset Content @@ -30241,7 +30959,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *231 + - *232 responses: '204': description: No content @@ -30264,13 +30982,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: - - *231 + - *232 responses: '200': description: Response content: application/json: - schema: &232 + schema: &233 title: Thread Subscription description: Thread Subscription type: object @@ -30314,7 +31032,7 @@ paths: - url - subscribed examples: - default: &233 + default: &234 value: subscribed: true ignored: false @@ -30345,7 +31063,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *231 + - *232 requestBody: required: false content: @@ -30366,9 +31084,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *233 examples: - default: *233 + default: *234 '304': *35 '403': *27 '401': *23 @@ -30391,7 +31109,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *231 + - *232 responses: '204': description: Response @@ -30488,7 +31206,7 @@ paths: type: array items: *67 examples: - default: *234 + default: *235 headers: Link: example: ; rel="next" @@ -30540,7 +31258,7 @@ paths: - 3 custom_roles: type: array - items: &312 + items: &316 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -30589,7 +31307,7 @@ paths: - created_at - updated_at examples: - default: &313 + default: &317 value: id: 8030 name: Security Engineer @@ -30916,7 +31634,7 @@ paths: type: array items: *145 examples: - default: &674 + default: &676 value: - property_name: environment value: production @@ -30966,7 +31684,7 @@ paths: required: - properties examples: - default: &675 + default: &677 value: properties: - property_name: environment @@ -30987,6 +31705,264 @@ paths: enabledForGitHubApps: true category: orgs subcategory: custom-properties-for-orgs + "/organizations/{org}/settings/billing/budgets": + get: + summary: Get all budgets for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-all-budgets-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-all-budgets-for-an-organization + parameters: + - *81 + responses: + '200': *236 + '404': *6 + '403': *27 + '500': *38 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing + "/organizations/{org}/settings/billing/budgets/{budget_id}": + get: + summary: Get a budget by ID for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a budget by ID. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-a-budget-by-id-for-an-organization + parameters: + - *81 + - *187 + responses: + '200': *237 + '400': *14 + '404': *6 + '403': *27 + '500': *38 + '503': *184 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing + patch: + summary: Update a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/update-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#update-a-budget-for-an-organization + parameters: + - *81 + - *187 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered in the + budget + examples: + update-budget: + summary: Update budget example + value: + prevent_further_usage: false + budget_amount: 10 + budget_alerting: + will_alert: false + alert_recipients: [] + responses: + '200': + description: Budget updated successfully + content: + application/json: + schema: + type: object + properties: + message: + type: string + examples: + - Budget successfully updated. + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_amount: + type: number + format: float + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the + budget is exceeded + budget_alerting: + type: object + required: + - will_alert + - alert_recipients + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + default: '' + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered + in the budget + examples: + update-budget: + value: + message: Budget successfully updated. + id: 550e8400-e29b-41d4-a716-446655440000 + '400': *14 + '401': *23 + '403': *27 + '404': + description: Budget not found or feature not enabled + content: + application/json: + schema: *3 + examples: + budget-not-found: + value: + message: Budget with ID 550e8400-e29b-41d4-a716-446655440000 not + found. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + feature-not-enabled: + value: + message: Not Found + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + '422': *15 + '500': + description: Internal server error + content: + application/json: + schema: *3 + examples: + server-error: + value: + message: Unable to update budget. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + delete: + summary: Delete a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/delete-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#delete-a-budget-for-an-organization + parameters: + - *81 + - *187 + responses: + '200': *238 + '400': *14 + '404': *6 + '403': *27 + '500': *38 + '503': *184 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization @@ -31002,12 +31978,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-an-organization parameters: - *81 - - *190 - - *192 - *191 - - *235 - - *236 - - *194 + - *193 + - *192 + - *239 + - *240 + - *195 responses: '200': description: Response when getting a billing premium request usage report @@ -31139,17 +32115,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - *81 - - *190 - - *237 - *191 + - *241 + - *192 responses: '200': description: Billing usage report response for an organization content: application/json: - schema: *238 + schema: *242 examples: - default: *239 + default: *243 '400': *14 '403': *27 '500': *38 @@ -31161,7 +32137,7 @@ paths: subcategory: enhanced-billing "/organizations/{org}/settings/billing/usage/summary": get: - summary: Get billing usage summary report for an organization + summary: Get billing usage summary for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. @@ -31174,18 +32150,18 @@ paths: operationId: billing/get-github-billing-usage-summary-report-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-report-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-for-an-organization parameters: - *81 - - *190 - - *192 - *191 - - *240 - - *194 - - *241 + - *193 + - *192 + - *244 + - *195 + - *245 responses: '200': - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -31319,7 +32295,7 @@ paths: description: Response content: application/json: - schema: &242 + schema: &246 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -31729,7 +32705,7 @@ paths: - updated_at - archived_at examples: - default-response: &243 + default-response: &247 value: login: github id: 1 @@ -32055,17 +33031,17 @@ paths: description: Response content: application/json: - schema: *242 + schema: *246 examples: - default: *243 + default: *247 '422': description: Validation failed content: application/json: schema: oneOf: - - *244 - - *245 + - *248 + - *249 '409': *112 x-github: githubCloudOnly: false @@ -32120,9 +33096,9 @@ paths: description: Response content: application/json: - schema: *246 + schema: *250 examples: - default: *247 + default: *251 headers: Link: *41 x-github: @@ -32163,7 +33139,7 @@ paths: type: integer repository_cache_usages: type: array - items: &467 + items: &468 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -32241,7 +33217,7 @@ paths: type: array items: *42 examples: - default: *248 + default: *252 headers: Link: *41 x-github: @@ -32408,7 +33384,7 @@ paths: application/json: schema: *43 examples: - default: *249 + default: *253 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32500,7 +33476,7 @@ paths: application/json: schema: *46 examples: - default: *250 + default: *254 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32619,9 +33595,9 @@ paths: description: Response content: application/json: - schema: *251 + schema: *255 examples: - default: *252 + default: *256 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32657,7 +33633,7 @@ paths: type: array items: *50 examples: - default: *253 + default: *257 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32846,7 +33822,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &254 + schema: &258 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -32860,7 +33836,7 @@ paths: required: - include_claim_keys examples: - default: &255 + default: &259 value: include_claim_keys: - repo @@ -32887,15 +33863,15 @@ paths: required: true content: application/json: - schema: *254 + schema: *258 examples: - default: *255 + default: *259 responses: '201': description: Empty response content: application/json: - schema: &280 + schema: &284 title: Empty Object description: An object without any properties. type: object @@ -32934,7 +33910,7 @@ paths: schema: type: object properties: - enabled_repositories: &257 + enabled_repositories: &261 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -32948,7 +33924,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *54 - selected_actions_url: *256 + selected_actions_url: *260 sha_pinning_required: *55 required: - enabled_repositories @@ -32990,7 +33966,7 @@ paths: schema: type: object properties: - enabled_repositories: *257 + enabled_repositories: *261 allowed_actions: *54 sha_pinning_required: *55 required: @@ -33026,7 +34002,7 @@ paths: description: Response content: application/json: - schema: *258 + schema: *262 examples: response: summary: Example response @@ -33057,7 +34033,7 @@ paths: required: true content: application/json: - schema: *259 + schema: *263 examples: application/json: value: @@ -33095,7 +34071,7 @@ paths: application/json: schema: *56 examples: - default: *260 + default: *264 '404': *6 x-github: enabledForGitHubApps: true @@ -33152,7 +34128,7 @@ paths: description: Response content: application/json: - schema: *261 + schema: *265 examples: default: *57 '403': *27 @@ -33177,7 +34153,7 @@ paths: required: true content: application/json: - schema: *262 + schema: *266 examples: default: *57 responses: @@ -33229,7 +34205,7 @@ paths: type: array items: *72 examples: - default: &264 + default: &268 value: total_count: 1 repositories: @@ -33414,7 +34390,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *81 - - &263 + - &267 name: repository_id description: The unique identifier of the repository. in: path @@ -33443,7 +34419,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *81 - - *263 + - *267 responses: '204': description: Response @@ -33639,7 +34615,7 @@ paths: type: array items: *72 examples: - default: *264 + default: *268 '403': *27 '404': *6 x-github: @@ -33708,7 +34684,7 @@ paths: 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: - *81 - - *263 + - *267 responses: '204': description: No content @@ -33735,7 +34711,7 @@ paths: 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: - *81 - - *263 + - *267 responses: '204': description: No content @@ -33769,7 +34745,7 @@ paths: description: Response content: application/json: - schema: *265 + schema: *269 examples: default: *63 x-github: @@ -33803,7 +34779,7 @@ paths: required: false content: application/json: - schema: *266 + schema: *270 examples: default: *63 x-github: @@ -33850,7 +34826,7 @@ paths: type: number runner_groups: type: array - items: &267 + items: &271 type: object properties: id: @@ -34040,9 +35016,9 @@ paths: description: Response content: application/json: - schema: *267 + schema: *271 examples: - default: &268 + default: &272 value: id: 2 name: octo-runner-group @@ -34084,7 +35060,7 @@ paths: description: Response content: application/json: - schema: *267 + schema: *271 examples: default: value: @@ -34177,9 +35153,9 @@ paths: description: Response content: application/json: - schema: *267 + schema: *271 examples: - default: *268 + default: *272 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -34243,7 +35219,7 @@ paths: type: array items: *42 examples: - default: *248 + default: *252 headers: Link: *41 x-github: @@ -34284,9 +35260,9 @@ paths: type: number repositories: type: array - items: *269 + items: *273 examples: - default: &790 + default: &792 value: total_count: 1 repositories: @@ -34585,7 +35561,7 @@ paths: parameters: - *81 - *66 - - *263 + - *267 responses: '204': description: Response @@ -34609,7 +35585,7 @@ paths: parameters: - *81 - *66 - - *263 + - *267 responses: '204': description: Response @@ -34827,9 +35803,9 @@ paths: application/json: schema: type: array - items: *270 + items: *274 examples: - default: *271 + default: *275 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34894,7 +35870,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *272 + '201': *276 '404': *6 '422': *7 '409': *112 @@ -34933,7 +35909,7 @@ paths: application/json: schema: *73 examples: - default: *273 + default: *277 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34969,7 +35945,7 @@ paths: application/json: schema: *73 examples: - default: *274 + default: *278 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35000,7 +35976,7 @@ paths: application/json: schema: *70 examples: - default: *275 + default: *279 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35175,7 +36151,7 @@ paths: - *81 - *69 responses: - '200': *276 + '200': *280 '404': *6 x-github: githubCloudOnly: false @@ -35204,7 +36180,7 @@ paths: parameters: - *81 - *69 - - *277 + - *281 responses: '200': *75 '404': *6 @@ -35249,7 +36225,7 @@ paths: type: integer secrets: type: array - items: &278 + items: &282 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -35330,7 +36306,7 @@ paths: description: Response content: application/json: - schema: &487 + schema: &488 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -35365,7 +36341,7 @@ paths: - key_id - key examples: - default: &488 + default: &489 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -35391,7 +36367,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - *81 - - &279 + - &283 name: secret_name description: The name of the secret. in: path @@ -35403,7 +36379,7 @@ paths: description: Response content: application/json: - schema: *278 + schema: *282 examples: default: value: @@ -35434,7 +36410,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - *81 - - *279 + - *283 requestBody: required: true content: @@ -35491,7 +36467,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -35518,7 +36494,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - *81 - - *279 + - *283 responses: '204': description: Response @@ -35545,7 +36521,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - *81 - - *279 + - *283 - *19 - *17 responses: @@ -35563,9 +36539,9 @@ paths: type: integer repositories: type: array - items: *269 + items: *273 examples: - default: &283 + default: &287 value: total_count: 1 repositories: @@ -35658,7 +36634,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - *81 - - *279 + - *283 requestBody: required: true content: @@ -35711,7 +36687,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - *81 - - *279 + - *283 - name: repository_id in: path required: true @@ -35745,7 +36721,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - *81 - - *279 + - *283 - name: repository_id in: path required: true @@ -35778,7 +36754,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - *81 - - &472 + - &473 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)." @@ -35802,7 +36778,7 @@ paths: type: integer variables: type: array - items: &281 + items: &285 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -35940,7 +36916,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -35966,7 +36942,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - *81 - - &282 + - &286 name: name description: The name of the variable. in: path @@ -35978,7 +36954,7 @@ paths: description: Response content: application/json: - schema: *281 + schema: *285 examples: default: value: @@ -36009,7 +36985,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - *81 - - *282 + - *286 requestBody: required: true content: @@ -36072,7 +37048,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - *81 - - *282 + - *286 responses: '204': description: Response @@ -36099,7 +37075,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - *81 - - *282 + - *286 - *19 - *17 responses: @@ -36117,9 +37093,9 @@ paths: type: integer repositories: type: array - items: *269 + items: *273 examples: - default: *283 + default: *287 '409': description: Response when the visibility of the variable is not set to `selected` @@ -36146,7 +37122,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - *81 - - *282 + - *286 requestBody: required: true content: @@ -36196,7 +37172,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - *81 - - *282 + - *286 - name: repository_id in: path required: true @@ -36231,7 +37207,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - *81 - - *282 + - *286 - name: repository_id in: path required: true @@ -36289,7 +37265,7 @@ paths: required: true content: application/json: - schema: *284 + schema: *288 examples: default: *79 parameters: @@ -36606,12 +37582,12 @@ paths: required: - subject_digests examples: - default: &817 + default: &819 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &818 + withPredicateType: &820 value: subject_digests: - sha256:abc123 @@ -36670,7 +37646,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &819 + default: &821 value: attestations_subject_digests: - sha256:abc: @@ -37019,7 +37995,7 @@ paths: initiator: type: string examples: - default: &501 + default: &502 value: attestations: - bundle: @@ -37145,10 +38121,10 @@ paths: required: false schema: type: string - - *285 - - *286 - - *287 - - *288 + - *289 + - *290 + - *291 + - *292 - *17 responses: '200': @@ -37157,9 +38133,9 @@ paths: application/json: schema: type: array - items: *289 + items: *293 examples: - default: *290 + default: *294 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -37188,7 +38164,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37282,7 +38258,7 @@ paths: subcategory: bypass-requests parameters: - *81 - - &293 + - &297 name: repository_name description: The name of the repository to filter on. in: query @@ -37301,9 +38277,9 @@ paths: application/json: schema: type: array - items: *291 + items: *295 examples: - default: *292 + default: *296 '404': *6 '500': *38 "/orgs/{org}/bypass-requests/secret-scanning": @@ -37327,7 +38303,7 @@ paths: subcategory: delegated-bypass parameters: - *81 - - *293 + - *297 - *97 - *98 - *99 @@ -37341,9 +38317,9 @@ paths: application/json: schema: type: array - items: *294 + items: *298 examples: - default: *295 + default: *299 '404': *6 '500': *38 "/orgs/{org}/campaigns": @@ -37370,7 +38346,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &297 + schema: &301 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -37396,7 +38372,7 @@ paths: application/json: schema: type: array - items: &298 + items: &302 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -37427,7 +38403,7 @@ paths: team_managers: description: The campaign team managers type: array - items: *296 + items: *300 published_at: description: The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. @@ -37446,7 +38422,7 @@ paths: - string - 'null' format: date-time - state: *297 + state: *301 contact_link: description: The contact link of the campaign. type: @@ -37669,9 +38645,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *302 examples: - default: &299 + default: &303 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -37754,9 +38730,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *302 examples: - default: *299 + default: *303 '404': *6 '422': description: Unprocessable Entity @@ -37834,7 +38810,7 @@ paths: - string - 'null' format: uri - state: *297 + state: *301 examples: default: value: @@ -37844,9 +38820,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *302 examples: - default: *299 + default: *303 '400': description: Bad Request content: @@ -37913,8 +38889,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *81 - - *300 - - *301 + - *304 + - *305 - *102 - *103 - *19 @@ -37925,7 +38901,7 @@ paths: be returned. in: query required: false - schema: *302 + schema: *306 - name: sort description: The property by which to sort the results. in: query @@ -37941,7 +38917,7 @@ paths: be returned. in: query required: false - schema: &527 + schema: &528 type: string description: Severity of a code scanning alert. enum: @@ -37959,9 +38935,9 @@ paths: application/json: schema: type: array - items: *303 + items: *307 examples: - default: *304 + default: *308 headers: Link: *41 '404': *6 @@ -38176,7 +39152,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *305 + code_scanning_options: *309 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -38319,7 +39295,7 @@ paths: application/json: schema: *108 examples: - default: *306 + default: *310 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38347,9 +39323,9 @@ paths: description: Response content: application/json: - schema: *307 + schema: *311 examples: - default: *308 + default: *312 '304': *35 '403': *27 '404': *6 @@ -38436,7 +39412,7 @@ paths: application/json: schema: *108 examples: - default: *306 + default: *310 '304': *35 '403': *27 '404': *6 @@ -38858,7 +39834,7 @@ paths: default: value: default_for_new_repos: all - configuration: *306 + configuration: *310 '403': *27 '404': *6 x-github: @@ -38911,13 +39887,13 @@ paths: application/json: schema: type: array - items: *309 + items: *313 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *310 + repository: *314 '403': *27 '404': *6 x-github: @@ -38957,7 +39933,7 @@ paths: type: integer codespaces: type: array - items: &356 + items: &360 type: object title: Codespace description: A codespace. @@ -38988,11 +39964,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *269 + repository: *273 machine: anyOf: - type: 'null' - - &556 + - &557 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -39279,7 +40255,7 @@ paths: - pulls_url - recent_folders examples: - default: &357 + default: &361 value: total_count: 3 codespaces: @@ -39903,7 +40879,7 @@ paths: type: integer secrets: type: array - items: &311 + items: &315 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -39944,7 +40920,7 @@ paths: - updated_at - visibility examples: - default: &557 + default: &558 value: total_count: 2 secrets: @@ -39982,7 +40958,7 @@ paths: description: Response content: application/json: - schema: &558 + schema: &559 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -40017,7 +40993,7 @@ paths: - key_id - key examples: - default: &559 + default: &560 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -40041,15 +41017,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - *81 - - *279 + - *283 responses: '200': description: Response content: application/json: - schema: *311 + schema: *315 examples: - default: &561 + default: &562 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -40077,7 +41053,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - *81 - - *279 + - *283 requestBody: required: true content: @@ -40132,7 +41108,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -40159,7 +41135,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - *81 - - *279 + - *283 responses: '204': description: Response @@ -40185,7 +41161,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - *81 - - *279 + - *283 - *19 - *17 responses: @@ -40203,9 +41179,9 @@ paths: type: integer repositories: type: array - items: *269 + items: *273 examples: - default: *283 + default: *287 '404': *6 x-github: githubCloudOnly: false @@ -40228,7 +41204,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - *81 - - *279 + - *283 requestBody: required: true content: @@ -40279,7 +41255,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - *81 - - *279 + - *283 - name: repository_id in: path required: true @@ -40313,7 +41289,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - *81 - - *279 + - *283 - name: repository_id in: path required: true @@ -40902,13 +41878,13 @@ paths: application/json: schema: type: array - items: *195 + items: *196 examples: - default: *196 + default: *197 '500': *38 '403': *27 '404': *6 - '422': *197 + '422': *198 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41136,7 +42112,7 @@ paths: - 3 custom_roles: type: array - items: *312 + items: *316 examples: default: value: @@ -41228,7 +42204,7 @@ paths: required: true content: application/json: - schema: &314 + schema: &318 type: object properties: name: @@ -41270,9 +42246,9 @@ paths: description: Response content: application/json: - schema: *312 + schema: *316 examples: - default: *313 + default: *317 '422': *15 '404': *6 x-github: @@ -41303,9 +42279,9 @@ paths: description: Response content: application/json: - schema: *312 + schema: *316 examples: - default: *313 + default: *317 '404': *6 x-github: githubCloudOnly: true @@ -41333,7 +42309,7 @@ paths: required: true content: application/json: - schema: &315 + schema: &319 type: object properties: name: @@ -41372,9 +42348,9 @@ paths: description: Response content: application/json: - schema: *312 + schema: *316 examples: - default: *313 + default: *317 '422': *15 '404': *6 x-github: @@ -41432,7 +42408,7 @@ paths: required: true content: application/json: - schema: *314 + schema: *318 examples: default: value: @@ -41446,9 +42422,9 @@ paths: description: Response content: application/json: - schema: *312 + schema: *316 examples: - default: *313 + default: *317 '422': *15 '404': *6 x-github: @@ -41485,9 +42461,9 @@ paths: description: Response content: application/json: - schema: *312 + schema: *316 examples: - default: *313 + default: *317 '404': *6 x-github: githubCloudOnly: true @@ -41521,7 +42497,7 @@ paths: required: true content: application/json: - schema: *315 + schema: *319 examples: default: value: @@ -41536,9 +42512,9 @@ paths: description: Response content: application/json: - schema: *312 + schema: *316 examples: - default: *313 + default: *317 '422': *15 '404': *6 x-github: @@ -41598,11 +42574,11 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *81 - - *316 - - *317 - - *318 - - *319 - *320 + - *321 + - *322 + - *323 + - *324 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -41640,8 +42616,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *321 - - *322 + - *325 + - *326 - *104 - *102 - *103 @@ -41653,9 +42629,9 @@ paths: application/json: schema: type: array - items: *323 + items: *327 examples: - default: *324 + default: *328 '304': *35 '400': *14 '403': *27 @@ -41699,7 +42675,7 @@ paths: type: integer secrets: type: array - items: &325 + items: &329 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -41778,7 +42754,7 @@ paths: description: Response content: application/json: - schema: &584 + schema: &585 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -41797,7 +42773,7 @@ paths: - key_id - key examples: - default: &585 + default: &586 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -41821,13 +42797,13 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - *81 - - *279 + - *283 responses: '200': description: Response content: application/json: - schema: *325 + schema: *329 examples: default: value: @@ -41856,7 +42832,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - *81 - - *279 + - *283 requestBody: required: true content: @@ -41915,7 +42891,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -41940,7 +42916,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - *81 - - *279 + - *283 responses: '204': description: Response @@ -41965,7 +42941,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - *81 - - *279 + - *283 - *19 - *17 responses: @@ -41983,9 +42959,9 @@ paths: type: integer repositories: type: array - items: *269 + items: *273 examples: - default: *283 + default: *287 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42007,7 +42983,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - *81 - - *279 + - *283 requestBody: required: true content: @@ -42058,7 +43034,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - *81 - - *279 + - *283 - name: repository_id in: path required: true @@ -42090,7 +43066,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - *81 - - *279 + - *283 - name: repository_id in: path required: true @@ -42127,7 +43103,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *81 - - &593 + - &594 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -42135,7 +43111,7 @@ paths: required: false schema: type: string - - &594 + - &595 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -42143,7 +43119,7 @@ paths: required: false schema: type: string - - &595 + - &596 name: time_period description: |- The time period to filter by. @@ -42159,7 +43135,7 @@ paths: - week - month default: month - - &596 + - &597 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -42174,7 +43150,7 @@ paths: - denied - all default: all - - *293 + - *297 - *17 - *19 responses: @@ -42184,7 +43160,7 @@ paths: application/json: schema: type: array - items: &597 + items: &598 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -42347,7 +43323,7 @@ paths: examples: - https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &598 + default: &599 value: - id: 21 number: 42 @@ -42434,11 +43410,11 @@ paths: subcategory: alert-dismissal-requests parameters: - *81 - - *293 + - *297 - *97 - *98 - *99 - - &599 + - &600 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -42464,7 +43440,7 @@ paths: application/json: schema: type: array - items: &600 + items: &601 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -42591,7 +43567,7 @@ paths: examples: - https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &601 + default: &602 value: - id: 21 number: 42 @@ -42679,7 +43655,7 @@ paths: application/json: schema: type: array - items: &366 + items: &370 title: Package description: A software package type: object @@ -42732,7 +43708,7 @@ paths: repository: anyOf: - type: 'null' - - *269 + - *273 created_at: type: string format: date-time @@ -42750,7 +43726,7 @@ paths: - created_at - updated_at examples: - default: &367 + default: &371 value: - id: 197 name: hello_docker @@ -42838,7 +43814,7 @@ paths: application/json: schema: type: array - items: *229 + items: *230 examples: 200-response: value: @@ -42937,7 +43913,7 @@ paths: description: Response content: application/json: - schema: &443 + schema: &446 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -43027,7 +44003,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &444 + default: &447 value: group_id: '123' group_name: Octocat admins @@ -43082,7 +44058,7 @@ paths: description: Response content: application/json: - schema: &441 + schema: &444 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -43122,7 +44098,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &442 + default: &445 value: groups: - group_id: '123' @@ -43166,7 +44142,7 @@ paths: application/json: schema: type: array - items: &348 + items: &352 title: Organization Invitation description: Organization Invitation type: object @@ -43220,7 +44196,7 @@ paths: - invitation_teams_url - node_id examples: - default: &349 + default: &353 value: - id: 1 login: monalisa @@ -43287,7 +44263,7 @@ paths: application/json: schema: type: array - items: &396 + items: &399 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -43301,7 +44277,7 @@ paths: - name - description examples: - default: &397 + default: &400 value: - name: add_assignee description: Assign or remove a user @@ -43342,7 +44318,7 @@ paths: application/json: schema: type: array - items: &326 + items: &330 title: Org Hook description: Org Hook type: object @@ -43525,9 +44501,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *330 examples: - default: &327 + default: &331 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -43572,7 +44548,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - *81 - - &328 + - &332 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. @@ -43585,9 +44561,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *330 examples: - default: *327 + default: *331 '404': *6 x-github: githubCloudOnly: false @@ -43609,7 +44585,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - *81 - - *328 + - *332 requestBody: required: false content: @@ -43655,7 +44631,7 @@ paths: description: Response content: application/json: - schema: *326 + schema: *330 examples: default: value: @@ -43695,7 +44671,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - *81 - - *328 + - *332 responses: '204': description: Response @@ -43721,7 +44697,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *81 - - *328 + - *332 responses: '200': description: Response @@ -43750,7 +44726,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *81 - - *328 + - *332 requestBody: required: false content: @@ -43799,9 +44775,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *81 - - *328 + - *332 - *17 - - *329 + - *333 responses: '200': description: Response @@ -43809,9 +44785,9 @@ paths: application/json: schema: type: array - items: *330 + items: *334 examples: - default: *331 + default: *335 '400': *14 '422': *15 x-github: @@ -43835,16 +44811,16 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *81 - - *328 + - *332 - *16 responses: '200': description: Response content: application/json: - schema: *332 + schema: *336 examples: - default: *333 + default: *337 '400': *14 '422': *15 x-github: @@ -43868,7 +44844,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *81 - - *328 + - *332 - *16 responses: '202': *37 @@ -43895,7 +44871,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - *81 - - *328 + - *332 responses: '204': description: Response @@ -43918,7 +44894,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - *81 - - &338 + - &342 name: actor_type in: path description: The type of the actor @@ -43931,14 +44907,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &339 + - &343 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &334 + - &338 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`.' @@ -43946,7 +44922,7 @@ paths: required: true schema: type: string - - &335 + - &339 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) @@ -44041,12 +45017,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - *81 - - *334 - - *335 + - *338 + - *339 - *19 - *17 - *104 - - &344 + - &348 name: sort description: The property to sort the results by. in: query @@ -44126,14 +45102,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - *81 - - *334 - - *335 + - *338 + - *339 responses: '200': description: Response content: application/json: - schema: &336 + schema: &340 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -44149,7 +45125,7 @@ paths: type: integer format: int64 examples: - default: &337 + default: &341 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -44170,23 +45146,23 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - *81 - - &340 + - &344 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *334 - - *335 + - *338 + - *339 responses: '200': description: Response content: application/json: - schema: *336 + schema: *340 examples: - default: *337 + default: *341 x-github: enabledForGitHubApps: true category: orgs @@ -44205,18 +45181,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *81 - - *334 - - *335 - *338 - *339 + - *342 + - *343 responses: '200': description: Response content: application/json: - schema: *336 + schema: *340 examples: - default: *337 + default: *341 x-github: enabledForGitHubApps: true category: orgs @@ -44234,9 +45210,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - *81 - - *334 - - *335 - - &341 + - *338 + - *339 + - &345 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -44249,7 +45225,7 @@ paths: description: Response content: application/json: - schema: &342 + schema: &346 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -44265,7 +45241,7 @@ paths: type: integer format: int64 examples: - default: &343 + default: &347 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -44302,18 +45278,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - *81 - - *340 - - *334 - - *335 - - *341 + - *344 + - *338 + - *339 + - *345 responses: '200': description: Response content: application/json: - schema: *342 + schema: *346 examples: - default: *343 + default: *347 x-github: enabledForGitHubApps: true category: orgs @@ -44331,19 +45307,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - *81 + - *342 + - *343 - *338 - *339 - - *334 - - *335 - - *341 + - *345 responses: '200': description: Response content: application/json: - schema: *342 + schema: *346 examples: - default: *343 + default: *347 x-github: enabledForGitHubApps: true category: orgs @@ -44361,13 +45337,13 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - *81 - - *340 - - *334 - - *335 + - *344 + - *338 + - *339 - *19 - *17 - *104 - - *344 + - *348 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -44451,7 +45427,7 @@ paths: application/json: schema: *20 examples: - default: &632 + default: &633 value: id: 1 account: @@ -44617,12 +45593,12 @@ paths: application/json: schema: anyOf: - - &346 + - &350 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &345 + limit: &349 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -44650,7 +45626,7 @@ paths: properties: {} additionalProperties: false examples: - default: &347 + default: &351 value: limit: collaborators_only origin: organization @@ -44679,13 +45655,13 @@ paths: required: true content: application/json: - schema: &633 + schema: &634 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *345 + limit: *349 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -44710,9 +45686,9 @@ paths: description: Response content: application/json: - schema: *346 + schema: *350 examples: - default: *347 + default: *351 '422': *15 x-github: githubCloudOnly: false @@ -44790,9 +45766,9 @@ paths: application/json: schema: type: array - items: *348 + items: *352 examples: - default: *349 + default: *353 headers: Link: *41 '404': *6 @@ -44870,7 +45846,7 @@ paths: description: Response content: application/json: - schema: *348 + schema: *352 examples: default: value: @@ -44927,7 +45903,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - *81 - - &350 + - &354 name: invitation_id description: The unique identifier of the invitation. in: path @@ -44961,7 +45937,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - *81 - - *350 + - *354 - *17 - *19 responses: @@ -44971,9 +45947,9 @@ paths: application/json: schema: type: array - items: *296 + items: *300 examples: - default: &365 + default: &369 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -45016,7 +45992,7 @@ paths: application/json: schema: type: array - items: *351 + items: *355 examples: default: value: @@ -45104,9 +46080,9 @@ paths: description: Response content: application/json: - schema: *351 + schema: *355 examples: - default: &352 + default: &356 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -45139,7 +46115,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *81 - - &353 + - &357 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -45195,9 +46171,9 @@ paths: description: Response content: application/json: - schema: *351 + schema: *355 examples: - default: *352 + default: *356 '404': *6 '422': *7 x-github: @@ -45222,7 +46198,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *81 - - *353 + - *357 responses: '204': description: Response @@ -45285,7 +46261,7 @@ paths: - closed - all default: open - - *354 + - *358 - name: type description: Can be the name of an issue type. in: query @@ -45304,7 +46280,7 @@ paths: - comments default: created - *104 - - *208 + - *209 - *17 - *19 responses: @@ -45314,9 +46290,9 @@ paths: application/json: schema: type: array - items: *218 + items: *219 examples: - default: *355 + default: *359 headers: Link: *41 '404': *6 @@ -45376,7 +46352,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 '422': *15 @@ -45475,9 +46451,9 @@ paths: type: integer codespaces: type: array - items: *356 + items: *360 examples: - default: *357 + default: *361 '304': *35 '500': *38 '401': *23 @@ -45504,7 +46480,7 @@ paths: parameters: - *81 - *132 - - &358 + - &362 name: codespace_name in: path required: true @@ -45539,15 +46515,15 @@ paths: parameters: - *81 - *132 - - *358 + - *362 responses: '200': description: Response content: application/json: - schema: *356 + schema: *360 examples: - default: &555 + default: &556 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -45803,7 +46779,7 @@ paths: description: Response content: application/json: - schema: &359 + schema: &363 title: Org Membership description: Org Membership type: object @@ -45872,7 +46848,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &360 + response-if-user-has-an-active-admin-membership-with-organization: &364 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -45969,9 +46945,9 @@ paths: description: Response content: application/json: - schema: *359 + schema: *363 examples: - response-if-user-already-had-membership-with-organization: *360 + response-if-user-already-had-membership-with-organization: *364 '422': *15 '403': *27 x-github: @@ -46043,7 +47019,7 @@ paths: application/json: schema: type: array - items: &361 + items: &365 title: Migration description: A migration. type: object @@ -46381,7 +47357,7 @@ paths: description: Response content: application/json: - schema: *361 + schema: *365 examples: default: value: @@ -46560,7 +47536,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - *81 - - &362 + - &366 name: migration_id description: The unique identifier of the migration. in: path @@ -46588,7 +47564,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *361 + schema: *365 examples: default: value: @@ -46758,7 +47734,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - *81 - - *362 + - *366 responses: '302': description: Response @@ -46780,7 +47756,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *81 - - *362 + - *366 responses: '204': description: Response @@ -46804,8 +47780,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - *81 - - *362 - - &802 + - *366 + - &804 name: repo_name description: repo_name parameter in: path @@ -46833,7 +47809,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *81 - - *362 + - *366 - *17 - *19 responses: @@ -46843,9 +47819,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: &372 + default: &376 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -47054,7 +48030,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &363 + items: &367 title: Organization Role description: Organization roles type: object @@ -47263,7 +48239,7 @@ paths: description: Response content: application/json: - schema: *363 + schema: *367 examples: default: value: @@ -47315,7 +48291,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - *81 - - *203 + - *204 responses: '204': description: Response @@ -47341,7 +48317,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - *81 - - *203 + - *204 - *131 responses: '204': @@ -47372,7 +48348,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - *81 - - *203 + - *204 - *131 responses: '204': @@ -47493,7 +48469,7 @@ paths: description: Response content: application/json: - schema: *363 + schema: *367 examples: default: value: @@ -47590,7 +48566,7 @@ paths: description: Response content: application/json: - schema: *363 + schema: *367 examples: default: value: @@ -47749,7 +48725,7 @@ paths: parent: anyOf: - type: 'null' - - *364 + - *368 type: description: The ownership type of the team type: string @@ -47782,7 +48758,7 @@ paths: - type - parent examples: - default: *365 + default: *369 headers: Link: *41 '404': @@ -47841,7 +48817,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *364 + items: *368 name: type: - string @@ -47958,7 +48934,7 @@ paths: - type - url examples: - default: *200 + default: *201 headers: Link: *41 '404': @@ -48009,7 +48985,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 x-github: @@ -48151,7 +49127,7 @@ paths: - nuget - container - *81 - - &803 + - &805 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -48187,12 +49163,12 @@ paths: application/json: schema: type: array - items: *366 + items: *370 examples: - default: *367 + default: *371 '403': *27 '401': *23 - '400': &805 + '400': &807 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -48214,7 +49190,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &368 + - &372 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 @@ -48232,7 +49208,7 @@ paths: - docker - nuget - container - - &369 + - &373 name: package_name description: The name of the package. in: path @@ -48245,7 +49221,7 @@ paths: description: Response content: application/json: - schema: *366 + schema: *370 examples: default: value: @@ -48297,8 +49273,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *368 - - *369 + - *372 + - *373 - *81 responses: '204': @@ -48331,8 +49307,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *368 - - *369 + - *372 + - *373 - *81 - name: token description: package token @@ -48365,8 +49341,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-an-organization parameters: - - *368 - - *369 + - *372 + - *373 - *81 - *19 - *17 @@ -48387,7 +49363,7 @@ paths: application/json: schema: type: array - items: &370 + items: &374 title: Package Version description: A version of a software package type: object @@ -48522,10 +49498,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: - - *368 - - *369 + - *372 + - *373 - *81 - - &371 + - &375 name: package_version_id description: Unique identifier of the package version. in: path @@ -48537,7 +49513,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *374 examples: default: value: @@ -48573,10 +49549,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *368 - - *369 + - *372 + - *373 - *81 - - *371 + - *375 responses: '204': description: Response @@ -48608,10 +49584,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *368 - - *369 + - *372 + - *373 - *81 - - *371 + - *375 responses: '204': description: Response @@ -48641,7 +49617,7 @@ paths: - *81 - *17 - *19 - - &373 + - &377 name: sort description: The property by which to sort the results. in: query @@ -48652,7 +49628,7 @@ paths: - created_at default: created_at - *104 - - &374 + - &378 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -48664,7 +49640,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &375 + - &379 name: repository description: The name of the repository to use to filter the results. in: query @@ -48673,7 +49649,7 @@ paths: type: string examples: - Hello-World - - &376 + - &380 name: permission description: The permission to use to filter the results. in: query @@ -48682,7 +49658,7 @@ paths: type: string examples: - issues_read - - &377 + - &381 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) @@ -48692,7 +49668,7 @@ paths: schema: type: string format: date-time - - &378 + - &382 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) @@ -48702,7 +49678,7 @@ paths: schema: type: string format: date-time - - &379 + - &383 name: token_id description: The ID of the token in: query @@ -49019,9 +49995,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: *372 + default: *376 headers: Link: *41 x-github: @@ -49047,14 +50023,14 @@ paths: - *81 - *17 - *19 - - *373 - - *104 - - *374 - - *375 - - *376 - *377 + - *104 - *378 - *379 + - *380 + - *381 + - *382 + - *383 responses: '500': *38 '422': *15 @@ -49336,9 +50312,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: *372 + default: *376 headers: Link: *41 x-github: @@ -49380,7 +50356,7 @@ paths: type: integer configurations: type: array - items: &380 + items: &384 title: Organization private registry description: Private registry configuration for an organization type: object @@ -49676,7 +50652,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &381 + org-private-registry-with-selected-visibility: &385 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -49768,15 +50744,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - *81 - - *279 + - *283 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *380 + schema: *384 examples: - default: *381 + default: *385 '404': *6 x-github: githubCloudOnly: false @@ -49798,7 +50774,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - *81 - - *279 + - *283 requestBody: required: true content: @@ -49904,7 +50880,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - *81 - - *279 + - *283 responses: '204': description: Response @@ -49915,275 +50891,6 @@ paths: enabledForGitHubApps: true category: private-registries subcategory: organization-configurations - "/orgs/{org}/projects": - get: - summary: List organization 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: - - projects-classic - operationId: projects-classic/list-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-organization-projects - parameters: - - *81 - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &382 - title: Project - description: Projects are a way to organize columns and cards of - work. - type: object - properties: - owner_url: - type: string - format: uri - examples: - - https://api.github.com/repos/api-playground/projects-test - url: - type: string - format: uri - examples: - - https://api.github.com/projects/1002604 - html_url: - type: string - format: uri - examples: - - https://github.com/api-playground/projects-test/projects/12 - columns_url: - type: string - format: uri - examples: - - https://api.github.com/projects/1002604/columns - id: - type: integer - examples: - - 1002604 - node_id: - type: string - examples: - - MDc6UHJvamVjdDEwMDI2MDQ= - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - number: - type: integer - examples: - - 1 - state: - description: State of the project; either 'open' or 'closed' - type: string - examples: - - open - creator: - anyOf: - - type: 'null' - - *4 - created_at: - type: string - format: date-time - examples: - - '2011-04-10T20:09:31Z' - updated_at: - type: string - format: date-time - examples: - - '2014-03-03T18:58:10Z' - organization_permission: - description: The baseline permission that all organization members - have on this project. Only present if owner is an organization. - type: string - enum: - - read - - write - - admin - - none - private: - description: Whether or not this project can be seen by everyone. - Only present if owner is an organization. - type: boolean - required: - - id - - node_id - - number - - name - - body - - state - - url - - html_url - - owner_url - - creator - - columns_url - - created_at - - updated_at - 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: true - headers: - Link: *41 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create an organization 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: - - projects-classic - operationId: projects-classic/create-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-an-organization-project - parameters: - - *81 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the project. - body: - type: string - description: The description of the project. - required: - - name - examples: - default: - value: - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - responses: - '201': - description: Response - content: - application/json: - schema: *382 - 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' - '401': *23 - '403': *27 - '404': *6 - '410': &459 - description: Gone - content: - application/json: - schema: *3 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/orgs/{org}/projectsV2": get: summary: List projects for organization @@ -50213,7 +50920,7 @@ paths: application/json: schema: type: array - items: &383 + items: &386 title: Projects v2 Project description: A projects v2 project type: object @@ -50287,7 +50994,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &880 + - &882 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -50372,7 +51079,7 @@ paths: - deleted_at - deleted_by examples: - default: &384 + default: &387 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -50475,7 +51182,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-organization parameters: - - &385 + - &388 name: project_number description: The project's number. in: path @@ -50488,9 +51195,9 @@ paths: description: Response content: application/json: - schema: *383 + schema: *386 examples: - default: *384 + default: *387 headers: Link: *41 '304': *35 @@ -50512,7 +51219,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-organization parameters: - - *385 + - *388 - *81 - *17 - *102 @@ -50524,7 +51231,7 @@ paths: application/json: schema: type: array - items: &386 + items: &389 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -50674,7 +51381,7 @@ paths: - updated_at - project_url examples: - default: &822 + default: &824 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -50777,8 +51484,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - - *385 - - &823 + - *388 + - &825 name: field_id description: The unique identifier of the field. in: path @@ -50791,9 +51498,9 @@ paths: description: Response content: application/json: - schema: *386 + schema: *389 examples: - default: &824 + default: &826 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -50837,7 +51544,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *385 + - *388 - *81 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) @@ -50870,7 +51577,7 @@ paths: application/json: schema: type: array - items: &391 + items: &394 title: Projects v2 Item description: An item belonging to a project type: object @@ -50887,7 +51594,7 @@ paths: description: The API URL of the project that contains this item. examples: - https://api.github.com/users/monalisa/2/projectsV2/3 - content_type: &389 + content_type: &392 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -50944,7 +51651,7 @@ paths: - updated_at - archived_at examples: - default: &392 + default: &395 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -51639,7 +52346,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-organization-owned-project parameters: - *81 - - *385 + - *388 requestBody: required: true description: Details of the item to add to the project. @@ -51676,7 +52383,7 @@ paths: description: Response content: application/json: - schema: &825 + schema: &827 title: Projects v2 Item description: An item belonging to a project type: object @@ -51689,8 +52396,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *218 - - &568 + - *219 + - &569 title: Pull Request Simple description: Pull Request Simple type: object @@ -51810,7 +52517,7 @@ paths: milestone: anyOf: - type: 'null' - - *387 + - *390 active_lock_reason: type: - string @@ -51865,7 +52572,7 @@ paths: type: - array - 'null' - items: *296 + items: *300 head: type: object properties: @@ -51909,7 +52616,7 @@ paths: _links: type: object properties: - comments: &388 + comments: &391 title: Link description: Hypermedia Link type: object @@ -51918,13 +52625,13 @@ paths: type: string required: - href - commits: *388 - statuses: *388 - html: *388 - issue: *388 - review_comments: *388 - review_comment: *388 - self: *388 + commits: *391 + statuses: *391 + html: *391 + issue: *391 + review_comments: *391 + review_comment: *391 + self: *391 required: - comments - commits @@ -51934,8 +52641,8 @@ paths: - review_comments - review_comment - self - author_association: *205 - auto_merge: &677 + author_association: *206 + auto_merge: &679 title: Auto merge description: The status of auto merging a pull request. type: @@ -52037,7 +52744,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: *389 + content_type: *392 creator: *4 created_at: type: string @@ -52074,7 +52781,7 @@ paths: - updated_at - archived_at examples: - issue: &390 + issue: &393 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -52129,7 +52836,7 @@ paths: archived_at: project_url: https://api.github.com/users/octocat/projectsV2/1 item_url: https://api.github.com/users/octocat/projectsV2/items/17 - pull_request: *390 + pull_request: *393 '304': *35 '403': *27 '401': *23 @@ -52149,9 +52856,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: - - *385 + - *388 - *81 - - &393 + - &396 name: item_id description: The unique identifier of the project item. in: path @@ -52177,9 +52884,9 @@ paths: description: Response content: application/json: - schema: *391 + schema: *394 examples: - default: *392 + default: *395 headers: Link: *41 '304': *35 @@ -52200,9 +52907,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-organization parameters: - - *385 + - *388 - *81 - - *393 + - *396 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -52275,13 +52982,13 @@ paths: description: Response content: application/json: - schema: *391 + schema: *394 examples: - text_field: *392 - number_field: *392 - date_field: *392 - single_select_field: *392 - iteration_field: *392 + text_field: *395 + number_field: *395 + date_field: *395 + single_select_field: *395 + iteration_field: *395 '401': *23 '403': *27 '404': *6 @@ -52301,9 +53008,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-organization parameters: - - *385 + - *388 - *81 - - *393 + - *396 responses: '204': description: Response @@ -52466,7 +53173,7 @@ paths: required: true content: application/json: - schema: *394 + schema: *397 examples: default: value: @@ -52694,7 +53401,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 x-github: @@ -52832,9 +53539,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: *372 + default: *376 headers: Link: *41 x-github: @@ -53038,7 +53745,7 @@ paths: description: Response content: application/json: - schema: &461 + schema: &462 title: Full Repository description: Full Repository type: object @@ -53484,7 +54191,7 @@ paths: license: anyOf: - type: 'null' - - *219 + - *220 organization: anyOf: - type: 'null' @@ -53503,7 +54210,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &573 + code_of_conduct: &574 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -53533,7 +54240,7 @@ paths: - key - name - html_url - security_and_analysis: *395 + security_and_analysis: *398 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -53617,7 +54324,7 @@ paths: - network_count - subscribers_count examples: - default: &463 + default: &464 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -54143,9 +54850,9 @@ paths: application/json: schema: type: array - items: *396 + items: *399 examples: - default: *397 + default: *400 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -54170,7 +54877,7 @@ paths: - *81 - *17 - *19 - - &700 + - &702 name: targets description: | A comma-separated list of rule targets to filter by. @@ -54262,11 +54969,11 @@ paths: type: array description: The actors that can bypass the rules in this ruleset items: *158 - conditions: *398 + conditions: *401 rules: type: array description: An array of rules within the ruleset. - items: &400 + items: &403 title: Repository Rule type: object description: A repository rule. @@ -54330,7 +55037,7 @@ paths: application/json: schema: *179 examples: - default: &399 + default: &402 value: id: 21 name: super cool ruleset @@ -54385,7 +55092,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - *81 - - &702 + - &704 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 @@ -54395,16 +55102,16 @@ paths: schema: type: string x-multi-segment: true - - *293 + - *297 - *99 - - &703 + - &705 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 - - &704 + - &706 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -54424,7 +55131,7 @@ paths: description: Response content: application/json: - schema: &705 + schema: &707 title: Rule Suites description: Response type: array @@ -54480,7 +55187,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &706 + default: &708 value: - id: 21 actor_id: 12 @@ -54524,7 +55231,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *81 - - &707 + - &709 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -54540,7 +55247,7 @@ paths: description: Response content: application/json: - schema: &708 + schema: &710 title: Rule Suite description: Response type: object @@ -54647,7 +55354,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &709 + default: &711 value: id: 21 actor_id: 12 @@ -54722,7 +55429,7 @@ paths: application/json: schema: *179 examples: - default: *399 + default: *402 '404': *6 '500': *38 put: @@ -54771,11 +55478,11 @@ paths: type: array description: The actors that can bypass the rules in this ruleset items: *158 - conditions: *398 + conditions: *401 rules: description: An array of rules within the ruleset. type: array - items: *400 + items: *403 examples: default: value: @@ -54812,7 +55519,7 @@ paths: application/json: schema: *179 examples: - default: *399 + default: *402 '404': *6 '500': *38 delete: @@ -54871,7 +55578,7 @@ paths: type: array items: *183 examples: - default: *401 + default: *404 '404': *6 '500': *38 x-github: @@ -54908,7 +55615,7 @@ paths: description: Response content: application/json: - schema: *402 + schema: *405 examples: default: value: @@ -54971,14 +55678,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *81 - - *403 - - *404 - - *405 - *406 + - *407 + - *408 + - *409 - *104 - *19 - *17 - - &711 + - &713 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 @@ -54988,7 +55695,7 @@ paths: required: false schema: type: string - - &712 + - &714 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 @@ -54998,10 +55705,10 @@ paths: required: false schema: type: string - - *407 - - *408 - - *409 - *410 + - *411 + - *412 + - *413 responses: '200': description: Response @@ -55009,9 +55716,9 @@ paths: application/json: schema: type: array - items: *411 + items: *414 examples: - default: *412 + default: *415 headers: Link: *41 '404': *6 @@ -55046,9 +55753,9 @@ paths: description: Response content: application/json: - schema: *413 + schema: *416 examples: - default: *414 + default: *417 '403': *27 '404': *6 patch: @@ -55201,7 +55908,7 @@ paths: application/json: schema: type: array - items: &733 + items: &735 description: A repository security advisory. type: object properties: @@ -55445,7 +56152,7 @@ paths: login: type: string description: The username of the user credited. - type: *415 + type: *418 credits_detailed: type: - array @@ -55456,7 +56163,7 @@ paths: type: object properties: user: *4 - type: *415 + type: *418 state: type: string description: The state of the user's acceptance of the @@ -55482,7 +56189,7 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *296 + items: *300 private_fork: readOnly: true description: A temporary private fork of the advisory's repository @@ -55520,7 +56227,7 @@ paths: - private_fork additionalProperties: false examples: - default: &734 + default: &736 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -55907,9 +56614,9 @@ paths: application/json: schema: type: array - items: *364 + items: *368 examples: - default: *365 + default: *369 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55933,7 +56640,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - *81 - - *203 + - *204 responses: '204': description: Response @@ -55959,7 +56666,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - *81 - - *203 + - *204 responses: '204': description: Response @@ -55994,9 +56701,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *419 examples: - default: *417 + default: *420 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56021,7 +56728,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *81 - - *418 + - *421 - *17 - *19 responses: @@ -56029,9 +56736,9 @@ paths: description: Success content: application/json: - schema: *419 + schema: *422 examples: - default: *420 + default: *423 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -56059,9 +56766,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *424 examples: - default: *422 + default: *425 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56089,9 +56796,9 @@ paths: description: Response content: application/json: - schema: *423 + schema: *426 examples: - default: *424 + default: *427 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56237,9 +56944,9 @@ paths: type: integer repositories: type: array - items: *269 + items: *273 examples: - default: *283 + default: *287 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56308,7 +57015,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *81 - - *263 + - *267 responses: '204': description: Response @@ -56331,7 +57038,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *81 - - *263 + - *267 responses: '204': description: Response @@ -56374,7 +57081,7 @@ paths: type: array items: *137 examples: - default: *425 + default: *428 headers: Link: *41 x-github: @@ -56575,15 +57282,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - *81 - - *426 + - *429 responses: '200': description: Response content: application/json: - schema: *427 + schema: *430 examples: - default: *428 + default: *431 headers: Link: *41 x-github: @@ -56621,7 +57328,7 @@ paths: description: Response content: application/json: - schema: &450 + schema: &453 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -56673,7 +57380,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &451 + default: &454 value: groups: - group_id: '123' @@ -56719,7 +57426,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - *81 - - *203 + - *204 - 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`). @@ -56751,13 +57458,13 @@ paths: application/json: schema: type: array - items: *195 + items: *196 examples: - default: *196 + default: *197 '500': *38 '403': *27 '404': *6 - '422': *197 + '422': *198 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56785,9 +57492,9 @@ paths: application/json: schema: type: array - items: *296 + items: *300 examples: - default: *365 + default: *369 headers: Link: *41 '403': *27 @@ -56881,7 +57588,7 @@ paths: description: Response content: application/json: - schema: &429 + schema: &432 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -56955,7 +57662,7 @@ paths: parent: anyOf: - type: 'null' - - *364 + - *368 members_count: type: integer examples: @@ -57280,7 +57987,7 @@ paths: - repos_count - organization examples: - default: &430 + default: &433 value: id: 1 node_id: MDQ6VGVhbTE= @@ -57351,15 +58058,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - *81 - - *203 + - *204 responses: '200': description: Response content: application/json: - schema: *429 + schema: *432 examples: - default: *430 + default: *433 '404': *6 x-github: githubCloudOnly: false @@ -57381,7 +58088,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - *81 - - *203 + - *204 requestBody: required: false content: @@ -57444,16 +58151,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *429 + schema: *432 examples: - default: *430 + default: *433 '201': description: Response content: application/json: - schema: *429 + schema: *432 examples: - default: *430 + default: *433 '404': *6 '422': *15 '403': *27 @@ -57479,7 +58186,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - *81 - - *203 + - *204 responses: '204': description: Response @@ -57506,7 +58213,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - *81 - - *203 + - *204 - *104 - *17 - *19 @@ -57523,7 +58230,7 @@ paths: application/json: schema: type: array - items: &431 + items: &434 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -57614,7 +58321,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *206 + reactions: *207 required: - author - body @@ -57634,7 +58341,7 @@ paths: - updated_at - url examples: - default: &777 + default: &779 value: - author: login: octocat @@ -57709,7 +58416,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - *81 - - *203 + - *204 requestBody: required: true content: @@ -57743,9 +58450,9 @@ paths: description: Response content: application/json: - schema: *431 + schema: *434 examples: - default: &432 + default: &435 value: author: login: octocat @@ -57818,8 +58525,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - *81 - - *203 - - &433 + - *204 + - &436 name: discussion_number description: The number that identifies the discussion. in: path @@ -57831,9 +58538,9 @@ paths: description: Response content: application/json: - schema: *431 + schema: *434 examples: - default: *432 + default: *435 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57856,8 +58563,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - *81 - - *203 - - *433 + - *204 + - *436 requestBody: required: false content: @@ -57880,9 +58587,9 @@ paths: description: Response content: application/json: - schema: *431 + schema: *434 examples: - default: &778 + default: &780 value: author: login: octocat @@ -57953,8 +58660,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - *81 - - *203 - - *433 + - *204 + - *436 responses: '204': description: Response @@ -57981,8 +58688,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - *81 - - *203 - - *433 + - *204 + - *436 - *104 - *17 - *19 @@ -57993,7 +58700,7 @@ paths: application/json: schema: type: array - items: &434 + items: &437 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -58058,7 +58765,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *206 + reactions: *207 required: - author - body @@ -58073,7 +58780,7 @@ paths: - updated_at - url examples: - default: &779 + default: &781 value: - author: login: octocat @@ -58142,8 +58849,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - *81 - - *203 - - *433 + - *204 + - *436 requestBody: required: true content: @@ -58165,9 +58872,9 @@ paths: description: Response content: application/json: - schema: *434 + schema: *437 examples: - default: &435 + default: &438 value: author: login: octocat @@ -58234,9 +58941,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - *81 - - *203 - - *433 - - &436 + - *204 + - *436 + - &439 name: comment_number description: The number that identifies the comment. in: path @@ -58248,9 +58955,9 @@ paths: description: Response content: application/json: - schema: *434 + schema: *437 examples: - default: *435 + default: *438 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58273,9 +58980,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - *81 - - *203 - - *433 + - *204 - *436 + - *439 requestBody: required: true content: @@ -58297,9 +59004,9 @@ paths: description: Response content: application/json: - schema: *434 + schema: *437 examples: - default: &780 + default: &782 value: author: login: octocat @@ -58364,9 +59071,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - *81 - - *203 - - *433 + - *204 - *436 + - *439 responses: '204': description: Response @@ -58393,9 +59100,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - *81 - - *203 - - *433 + - *204 - *436 + - *439 - 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. @@ -58421,7 +59128,7 @@ paths: application/json: schema: type: array - items: &437 + items: &440 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -58465,7 +59172,7 @@ paths: - content - created_at examples: - default: &439 + default: &442 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -58516,9 +59223,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - *81 - - *203 - - *433 + - *204 - *436 + - *439 requestBody: required: true content: @@ -58551,9 +59258,9 @@ paths: team discussion comment content: application/json: - schema: *437 + schema: *440 examples: - default: &438 + default: &441 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -58582,9 +59289,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58608,10 +59315,10 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - *81 - - *203 - - *433 + - *204 - *436 - - &440 + - *439 + - &443 name: reaction_id description: The unique identifier of the reaction. in: path @@ -58644,8 +59351,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - *81 - - *203 - - *433 + - *204 + - *436 - 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. @@ -58671,9 +59378,9 @@ paths: application/json: schema: type: array - items: *437 + items: *440 examples: - default: *439 + default: *442 headers: Link: *41 x-github: @@ -58700,8 +59407,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - *81 - - *203 - - *433 + - *204 + - *436 requestBody: required: true content: @@ -58733,16 +59440,16 @@ paths: description: Response content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '201': description: Response content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -58766,9 +59473,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - *81 - - *203 - - *433 - - *440 + - *204 + - *436 + - *443 responses: '204': description: Response @@ -58792,15 +59499,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team parameters: - *81 - - *203 + - *204 responses: '200': description: Response content: application/json: - schema: *441 + schema: *444 examples: - default: *442 + default: *445 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -58820,7 +59527,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team parameters: - *81 - - *203 + - *204 requestBody: required: true content: @@ -58844,9 +59551,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *446 examples: - default: *444 + default: *447 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -58866,7 +59573,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team parameters: - *81 - - *203 + - *204 responses: '204': description: Response @@ -58891,7 +59598,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - *81 - - *203 + - *204 - *17 - *19 responses: @@ -58901,9 +59608,9 @@ paths: application/json: schema: type: array - items: *348 + items: *352 examples: - default: *349 + default: *353 headers: Link: *41 x-github: @@ -58926,7 +59633,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - *81 - - *203 + - *204 - name: role description: Filters members returned by their role in the team. in: query @@ -58949,7 +59656,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 x-github: @@ -58980,14 +59687,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - *81 - - *203 + - *204 - *132 responses: '200': description: Response content: application/json: - schema: &445 + schema: &448 title: Team Membership description: Team Membership type: object @@ -59015,7 +59722,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &781 + response-if-user-is-a-team-maintainer: &783 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -59052,7 +59759,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user parameters: - *81 - - *203 + - *204 - *132 requestBody: required: false @@ -59078,9 +59785,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *448 examples: - response-if-users-membership-with-team-is-now-pending: &782 + response-if-users-membership-with-team-is-now-pending: &784 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -59116,7 +59823,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - *81 - - *203 + - *204 - *132 responses: '204': @@ -59143,7 +59850,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - *81 - - *203 + - *204 - *17 - *19 responses: @@ -59153,7 +59860,7 @@ paths: application/json: schema: type: array - items: &446 + items: &449 title: Team Project description: A team's access to a project. type: object @@ -59222,7 +59929,7 @@ paths: - updated_at - permissions examples: - default: &783 + default: &785 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -59286,8 +59993,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - *81 - - *203 - - &447 + - *204 + - &450 name: project_id description: The unique identifier of the project. in: path @@ -59299,9 +60006,9 @@ paths: description: Response content: application/json: - schema: *446 + schema: *449 examples: - default: &784 + default: &786 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -59364,8 +60071,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - *81 - - *203 - - *447 + - *204 + - *450 requestBody: required: false content: @@ -59433,8 +60140,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - *81 - - *203 - - *447 + - *204 + - *450 responses: '204': description: Response @@ -59462,7 +60169,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - *81 - - *203 + - *204 - *17 - *19 responses: @@ -59472,9 +60179,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: *372 + default: *376 headers: Link: *41 x-github: @@ -59504,15 +60211,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - *81 - - *203 - - *448 - - *449 + - *204 + - *451 + - *452 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &785 + schema: &787 title: Team Repository description: A team's access to a repository. type: object @@ -59538,7 +60245,7 @@ paths: license: anyOf: - type: 'null' - - *219 + - *220 forks: type: integer permissions: @@ -60154,9 +60861,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - *81 - - *203 - - *448 - - *449 + - *204 + - *451 + - *452 requestBody: required: false content: @@ -60202,9 +60909,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - *81 - - *203 - - *448 - - *449 + - *204 + - *451 + - *452 responses: '204': description: Response @@ -60231,15 +60938,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team parameters: - *81 - - *203 + - *204 responses: '200': description: Response content: application/json: - schema: *450 + schema: *453 examples: - default: *451 + default: *454 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -60262,7 +60969,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections parameters: - *81 - - *203 + - *204 requestBody: required: true content: @@ -60305,7 +61012,7 @@ paths: description: Response content: application/json: - schema: *450 + schema: *453 examples: default: value: @@ -60338,7 +61045,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - *81 - - *203 + - *204 - *17 - *19 responses: @@ -60348,9 +61055,9 @@ paths: application/json: schema: type: array - items: *296 + items: *300 examples: - response-if-child-teams-exist: &786 + response-if-child-teams-exist: &788 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -60477,7 +61184,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card parameters: - - &452 + - &455 name: card_id description: The unique identifier of the card. in: path @@ -60489,7 +61196,7 @@ paths: description: Response content: application/json: - schema: &453 + schema: &456 title: Project Card description: Project cards represent a scope of work. type: object @@ -60564,7 +61271,7 @@ paths: - created_at - updated_at examples: - default: &454 + default: &457 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -60620,7 +61327,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card parameters: - - *452 + - *455 requestBody: required: false content: @@ -60650,9 +61357,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *456 examples: - default: *454 + default: *457 '304': *35 '403': *27 '401': *23 @@ -60679,7 +61386,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card parameters: - - *452 + - *455 responses: '204': description: Response @@ -60723,7 +61430,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card parameters: - - *452 + - *455 requestBody: required: true content: @@ -60836,7 +61543,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column parameters: - - &455 + - &458 name: column_id description: The unique identifier of the column. in: path @@ -60848,7 +61555,7 @@ paths: description: Response content: application/json: - schema: &456 + schema: &459 title: Project Column description: Project columns contain cards of work. type: object @@ -60902,7 +61609,7 @@ paths: - created_at - updated_at examples: - default: &457 + default: &460 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -60937,7 +61644,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column parameters: - - *455 + - *458 requestBody: required: true content: @@ -60962,9 +61669,9 @@ paths: description: Response content: application/json: - schema: *456 + schema: *459 examples: - default: *457 + default: *460 '304': *35 '403': *27 '401': *23 @@ -60989,7 +61696,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column parameters: - - *455 + - *458 responses: '204': description: Response @@ -61018,7 +61725,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards parameters: - - *455 + - *458 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -61039,7 +61746,7 @@ paths: application/json: schema: type: array - items: *453 + items: *456 examples: default: value: @@ -61098,7 +61805,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card parameters: - - *455 + - *458 requestBody: required: true content: @@ -61142,9 +61849,9 @@ paths: description: Response content: application/json: - schema: *453 + schema: *456 examples: - default: *454 + default: *457 '304': *35 '403': *27 '401': *23 @@ -61154,8 +61861,8 @@ paths: application/json: schema: oneOf: - - *244 - - *245 + - *248 + - *249 '503': description: Response content: @@ -61200,7 +61907,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column parameters: - - *455 + - *458 requestBody: required: true content: @@ -61247,211 +61954,6 @@ paths: deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true - "/projects/{project_id}": - get: - summary: Get 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: - - projects-classic - operationId: projects-classic/get - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#get-a-project - parameters: - - *447 - responses: - '200': - description: Response - content: - application/json: - schema: *382 - examples: - default: &458 - value: - owner_url: https://api.github.com/repos/api-playground/projects-test - url: https://api.github.com/projects/1002604 - html_url: https://github.com/api-playground/projects-test/projects/1 - columns_url: https://api.github.com/projects/1002604/columns - id: 1002604 - node_id: MDc6UHJvamVjdDEwMDI2MDQ= - name: Projects Documentation - body: Developer documentation project for the developer site. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - '304': *35 - '403': *27 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update 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. - operationId: projects-classic/update - tags: - - projects-classic - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#update-a-project - parameters: - - *447 - requestBody: - required: false - content: - application/json: - schema: - properties: - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - state: - description: State of the project; either 'open' or 'closed' - type: string - examples: - - open - organization_permission: - description: The baseline permission that all organization members - have on this project - type: string - enum: - - read - - write - - admin - - none - private: - description: Whether or not this project can be seen by everyone. - type: boolean - type: object - examples: - default: - summary: Change the name, state, and permissions for a project - value: - name: Week One Sprint - state: open - organization_permission: write - responses: - '200': - description: Response - content: - application/json: - schema: *382 - examples: - default: *458 - '404': - description: Not Found if the authenticated user does not have access to - the project - '304': *35 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *23 - '410': *459 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete 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. - operationId: projects-classic/delete - tags: - - projects-classic - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#delete-a-project - parameters: - - *447 - responses: - '204': - description: Delete Success - '304': *35 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *23 - '410': *459 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/projects/{project_id}/collaborators": get: summary: List project collaborators @@ -61466,7 +61968,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators parameters: - - *447 + - *450 - 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 @@ -61493,7 +61995,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 '404': *6 @@ -61523,7 +62025,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator parameters: - - *447 + - *450 - *132 requestBody: required: false @@ -61578,7 +62080,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *447 + - *450 - *132 responses: '204': @@ -61610,7 +62112,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#get-project-permission-for-a-user parameters: - - *447 + - *450 - *132 responses: '200': @@ -61708,7 +62210,7 @@ paths: resources: type: object properties: - core: &460 + core: &461 title: Rate Limit type: object properties: @@ -61725,21 +62227,21 @@ paths: - remaining - reset - used - graphql: *460 - search: *460 - code_search: *460 - source_import: *460 - integration_manifest: *460 - code_scanning_upload: *460 - actions_runner_registration: *460 - scim: *460 - dependency_snapshots: *460 - dependency_sbom: *460 - code_scanning_autofix: *460 + graphql: *461 + search: *461 + code_search: *461 + source_import: *461 + integration_manifest: *461 + code_scanning_upload: *461 + actions_runner_registration: *461 + scim: *461 + dependency_snapshots: *461 + dependency_sbom: *461 + code_scanning_autofix: *461 required: - core - search - rate: *460 + rate: *461 required: - rate - resources @@ -61844,14 +62346,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *461 + schema: *462 examples: default-response: summary: Default response @@ -62356,7 +62858,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *462 + '301': *463 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62374,8 +62876,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: false content: @@ -62633,10 +63135,10 @@ paths: description: Response content: application/json: - schema: *461 + schema: *462 examples: - default: *463 - '307': &464 + default: *464 + '307': &465 description: Temporary Redirect content: application/json: @@ -62665,8 +63167,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -62688,7 +63190,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository - '307': *464 + '307': *465 '404': *6 '409': *112 x-github: @@ -62712,11 +63214,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 - - &479 + - &480 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -62739,7 +63241,7 @@ paths: type: integer artifacts: type: array - items: &465 + items: &466 title: Artifact description: An artifact type: object @@ -62834,7 +63336,7 @@ paths: - expires_at - updated_at examples: - default: &480 + default: &481 value: total_count: 2 artifacts: @@ -62895,9 +63397,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *448 - - *449 - - &466 + - *451 + - *452 + - &467 name: artifact_id description: The unique identifier of the artifact. in: path @@ -62909,7 +63411,7 @@ paths: description: Response content: application/json: - schema: *465 + schema: *466 examples: default: value: @@ -62947,9 +63449,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *448 - - *449 - - *466 + - *451 + - *452 + - *467 responses: '204': description: Response @@ -62973,9 +63475,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *448 - - *449 - - *466 + - *451 + - *452 + - *467 - name: archive_format in: path required: true @@ -62989,7 +63491,11 @@ 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': *459 + '410': &637 + description: Gone + content: + application/json: + schema: *3 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63012,14 +63518,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *467 + schema: *468 examples: default: value: @@ -63045,11 +63551,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: - - *448 - - *449 + - *451 + - *452 - *17 - *19 - - &468 + - &469 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 @@ -63083,7 +63589,7 @@ paths: description: Response content: application/json: - schema: &469 + schema: &470 title: Repository actions caches description: Repository actions caches type: object @@ -63133,7 +63639,7 @@ paths: - total_count - actions_caches examples: - default: &470 + default: &471 value: total_count: 1 actions_caches: @@ -63165,23 +63671,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: - - *448 - - *449 + - *451 + - *452 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *468 + - *469 responses: '200': description: Response content: application/json: - schema: *469 + schema: *470 examples: - default: *470 + default: *471 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63201,8 +63707,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: - - *448 - - *449 + - *451 + - *452 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -63233,9 +63739,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: - - *448 - - *449 - - &471 + - *451 + - *452 + - &472 name: job_id description: The unique identifier of the job. in: path @@ -63247,7 +63753,7 @@ paths: description: Response content: application/json: - schema: &483 + schema: &484 title: Job description: Information of a job execution in a workflow run type: object @@ -63594,9 +64100,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: - - *448 - - *449 - - *471 + - *451 + - *452 + - *472 responses: '302': description: Response @@ -63624,9 +64130,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: - - *448 - - *449 - - *471 + - *451 + - *452 + - *472 requestBody: required: false content: @@ -63648,7 +64154,7 @@ paths: description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -63672,8 +64178,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Status response @@ -63723,8 +64229,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -63758,7 +64264,7 @@ paths: description: Empty response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -63787,8 +64293,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -63806,7 +64312,7 @@ paths: type: integer secrets: type: array - items: &485 + items: &486 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -63827,7 +64333,7 @@ paths: - created_at - updated_at examples: - default: &486 + default: &487 value: total_count: 2 secrets: @@ -63860,9 +64366,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *448 - - *449 - - *472 + - *451 + - *452 + - *473 - *19 responses: '200': @@ -63879,7 +64385,7 @@ paths: type: integer variables: type: array - items: &489 + items: &490 title: Actions Variable type: object properties: @@ -63913,7 +64419,7 @@ paths: - created_at - updated_at examples: - default: &490 + default: &491 value: total_count: 2 variables: @@ -63946,8 +64452,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -63956,11 +64462,11 @@ paths: schema: type: object properties: - enabled: &473 + enabled: &474 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *54 - selected_actions_url: *256 + selected_actions_url: *260 sha_pinning_required: *55 required: - enabled @@ -63991,8 +64497,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: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -64003,7 +64509,7 @@ paths: schema: type: object properties: - enabled: *473 + enabled: *474 allowed_actions: *54 sha_pinning_required: *55 required: @@ -64036,14 +64542,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: &474 + schema: &475 type: object properties: access_level: @@ -64061,7 +64567,7 @@ paths: required: - access_level examples: - default: &475 + default: &476 value: access_level: organization x-github: @@ -64086,15 +64592,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: application/json: - schema: *474 + schema: *475 examples: - default: *475 + default: *476 responses: '204': description: Response @@ -64118,14 +64624,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *258 + schema: *262 examples: default: value: @@ -64149,8 +64655,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: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Empty response for successful settings update @@ -64160,7 +64666,7 @@ paths: required: true content: application/json: - schema: *259 + schema: *263 examples: default: summary: Set retention days @@ -64184,8 +64690,8 @@ 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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -64193,7 +64699,7 @@ paths: application/json: schema: *56 examples: - default: *260 + default: *264 '404': *6 x-github: enabledForGitHubApps: true @@ -64212,8 +64718,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: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -64247,14 +64753,14 @@ 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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *261 + schema: *265 examples: default: *57 '403': *27 @@ -64276,13 +64782,13 @@ 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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: application/json: - schema: *262 + schema: *266 examples: default: *57 responses: @@ -64308,8 +64814,8 @@ 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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -64340,8 +64846,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: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -64373,14 +64879,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *265 + schema: *269 examples: default: *63 x-github: @@ -64403,8 +64909,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: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Success response @@ -64415,7 +64921,7 @@ paths: required: true content: application/json: - schema: *266 + schema: *270 examples: default: *63 x-github: @@ -64444,8 +64950,8 @@ paths: in: query schema: type: string - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -64489,8 +64995,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -64498,9 +65004,9 @@ paths: application/json: schema: type: array - items: *270 + items: *274 examples: - default: *271 + default: *275 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64522,8 +65028,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -64566,7 +65072,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *272 + '201': *276 '404': *6 '422': *7 '409': *112 @@ -64597,8 +65103,8 @@ 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: - - *448 - - *449 + - *451 + - *452 responses: '201': description: Response @@ -64606,7 +65112,7 @@ paths: application/json: schema: *73 examples: - default: *273 + default: *277 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64634,8 +65140,8 @@ 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: - - *448 - - *449 + - *451 + - *452 responses: '201': description: Response @@ -64643,7 +65149,7 @@ paths: application/json: schema: *73 examples: - default: *274 + default: *278 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64665,8 +65171,8 @@ 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: - - *448 - - *449 + - *451 + - *452 - *69 responses: '200': @@ -64675,7 +65181,7 @@ paths: application/json: schema: *70 examples: - default: *275 + default: *279 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64696,8 +65202,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-a-repository parameters: - - *448 - - *449 + - *451 + - *452 - *69 responses: '204': @@ -64724,8 +65230,8 @@ 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: - - *448 - - *449 + - *451 + - *452 - *69 responses: '200': *75 @@ -64750,8 +65256,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-a-repository parameters: - - *448 - - *449 + - *451 + - *452 - *69 requestBody: required: true @@ -64800,8 +65306,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-a-repository parameters: - - *448 - - *449 + - *451 + - *452 - *69 requestBody: required: true @@ -64851,11 +65357,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: - - *448 - - *449 + - *451 + - *452 - *69 responses: - '200': *276 + '200': *280 '404': *6 x-github: githubCloudOnly: false @@ -64882,10 +65388,10 @@ 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: - - *448 - - *449 + - *451 + - *452 - *69 - - *277 + - *281 responses: '200': *75 '404': *6 @@ -64913,9 +65419,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: - - *448 - - *449 - - &493 + - *451 + - *452 + - &494 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. @@ -64923,7 +65429,7 @@ paths: required: false schema: type: string - - &494 + - &495 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -64931,7 +65437,7 @@ paths: required: false schema: type: string - - &495 + - &496 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -64940,7 +65446,7 @@ paths: required: false schema: type: string - - &496 + - &497 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 @@ -64967,7 +65473,7 @@ paths: - pending - *17 - *19 - - &497 + - &498 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)." @@ -64976,7 +65482,7 @@ paths: schema: type: string format: date-time - - &476 + - &477 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -64985,13 +65491,13 @@ paths: schema: type: boolean default: false - - &498 + - &499 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &499 + - &500 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -65014,7 +65520,7 @@ paths: type: integer workflow_runs: type: array - items: &477 + items: &478 title: Workflow Run description: An invocation of a workflow type: object @@ -65131,7 +65637,7 @@ paths: type: - array - 'null' - items: &518 + items: &519 title: Pull Request Minimal type: object properties: @@ -65258,7 +65764,7 @@ paths: head_commit: anyOf: - type: 'null' - - &522 + - &523 title: Simple Commit description: A commit. type: object @@ -65332,8 +65838,8 @@ paths: - timestamp - author - committer - repository: *269 - head_repository: *269 + repository: *273 + head_repository: *273 head_repository_id: type: integer examples: @@ -65373,7 +65879,7 @@ paths: - workflow_url - pull_requests examples: - default: &500 + default: &501 value: total_count: 1 workflow_runs: @@ -65609,24 +66115,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *448 - - *449 - - &478 + - *451 + - *452 + - &479 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *476 + - *477 responses: '200': description: Response content: application/json: - schema: *477 + schema: *478 examples: - default: &481 + default: &482 value: id: 30433642 name: Build @@ -65867,9 +66373,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 responses: '204': description: Response @@ -65892,9 +66398,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: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 responses: '200': description: Response @@ -66022,15 +66528,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: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 responses: '201': description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -66057,12 +66563,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 - *17 - *19 - - *479 + - *480 responses: '200': description: Response @@ -66078,9 +66584,9 @@ paths: type: integer artifacts: type: array - items: *465 + items: *466 examples: - default: *480 + default: *481 headers: Link: *41 x-github: @@ -66104,25 +66610,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *448 - - *449 - - *478 - - &482 + - *451 + - *452 + - *479 + - &483 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *476 + - *477 responses: '200': description: Response content: application/json: - schema: *477 + schema: *478 examples: - default: *481 + default: *482 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66145,10 +66651,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: - - *448 - - *449 - - *478 - - *482 + - *451 + - *452 + - *479 + - *483 - *17 - *19 responses: @@ -66166,9 +66672,9 @@ paths: type: integer jobs: type: array - items: *483 + items: *484 examples: - default: &484 + default: &485 value: total_count: 1 jobs: @@ -66281,10 +66787,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *448 - - *449 - - *478 - - *482 + - *451 + - *452 + - *479 + - *483 responses: '302': description: Response @@ -66312,15 +66818,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 responses: '202': description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -66347,9 +66853,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: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 requestBody: required: true content: @@ -66416,15 +66922,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 responses: '202': description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -66451,9 +66957,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: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 - 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 @@ -66483,9 +66989,9 @@ paths: type: integer jobs: type: array - items: *483 + items: *484 examples: - default: *484 + default: *485 headers: Link: *41 x-github: @@ -66510,9 +67016,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 responses: '302': description: Response @@ -66539,9 +67045,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 responses: '204': description: Response @@ -66568,9 +67074,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: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 responses: '200': description: Response @@ -66639,7 +67145,7 @@ paths: items: type: object properties: - type: &602 + type: &603 type: string description: The type of reviewer. enum: @@ -66650,7 +67156,7 @@ paths: reviewer: anyOf: - *4 - - *296 + - *300 required: - environment - wait_timer @@ -66725,9 +67231,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: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 requestBody: required: true content: @@ -66777,7 +67283,7 @@ paths: application/json: schema: type: array - items: &588 + items: &589 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -66889,7 +67395,7 @@ paths: - created_at - updated_at examples: - default: &589 + default: &590 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -66945,9 +67451,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 requestBody: required: false content: @@ -66969,7 +67475,7 @@ paths: description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -66992,9 +67498,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: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 requestBody: required: false content: @@ -67016,7 +67522,7 @@ paths: description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -67049,9 +67555,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *448 - - *449 - - *478 + - *451 + - *452 + - *479 responses: '200': description: Response @@ -67188,8 +67694,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -67207,9 +67713,9 @@ paths: type: integer secrets: type: array - items: *485 + items: *486 examples: - default: *486 + default: *487 headers: Link: *41 x-github: @@ -67234,16 +67740,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *487 + schema: *488 examples: - default: *488 + default: *489 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67265,17 +67771,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *448 - - *449 - - *279 + - *451 + - *452 + - *283 responses: '200': description: Response content: application/json: - schema: *485 + schema: *486 examples: - default: &615 + default: &616 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -67301,9 +67807,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *448 - - *449 - - *279 + - *451 + - *452 + - *283 requestBody: required: true content: @@ -67334,7 +67840,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -67360,9 +67866,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *448 - - *449 - - *279 + - *451 + - *452 + - *283 responses: '204': description: Response @@ -67387,9 +67893,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *448 - - *449 - - *472 + - *451 + - *452 + - *473 - *19 responses: '200': @@ -67406,9 +67912,9 @@ paths: type: integer variables: type: array - items: *489 + items: *490 examples: - default: *490 + default: *491 headers: Link: *41 x-github: @@ -67431,8 +67937,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -67459,7 +67965,7 @@ paths: description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -67484,17 +67990,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *448 - - *449 - - *282 + - *451 + - *452 + - *286 responses: '200': description: Response content: application/json: - schema: *489 + schema: *490 examples: - default: &616 + default: &617 value: name: USERNAME value: octocat @@ -67520,9 +68026,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *448 - - *449 - - *282 + - *451 + - *452 + - *286 requestBody: required: true content: @@ -67564,9 +68070,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *448 - - *449 - - *282 + - *451 + - *452 + - *286 responses: '204': description: Response @@ -67591,8 +68097,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -67610,7 +68116,7 @@ paths: type: integer workflows: type: array - items: &491 + items: &492 title: Workflow description: A GitHub Actions workflow type: object @@ -67728,9 +68234,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *448 - - *449 - - &492 + - *451 + - *452 + - &493 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -67745,7 +68251,7 @@ paths: description: Response content: application/json: - schema: *491 + schema: *492 examples: default: value: @@ -67778,9 +68284,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *448 - - *449 - - *492 + - *451 + - *452 + - *493 responses: '204': description: Response @@ -67805,9 +68311,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *448 - - *449 - - *492 + - *451 + - *452 + - *493 responses: '204': description: Response @@ -67858,9 +68364,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *448 - - *449 - - *492 + - *451 + - *452 + - *493 responses: '204': description: Response @@ -67887,19 +68393,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: - - *448 - - *449 - - *492 + - *451 + - *452 - *493 - *494 - *495 - *496 + - *497 - *17 - *19 - - *497 - - *476 - *498 + - *477 - *499 + - *500 responses: '200': description: Response @@ -67915,9 +68421,9 @@ paths: type: integer workflow_runs: type: array - items: *477 + items: *478 examples: - default: *500 + default: *501 headers: Link: *41 x-github: @@ -67950,9 +68456,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *448 - - *449 - - *492 + - *451 + - *452 + - *493 responses: '200': description: Response @@ -68013,8 +68519,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *448 - - *449 + - *451 + - *452 - *104 - *17 - *102 @@ -68182,8 +68688,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -68195,7 +68701,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 '404': *6 @@ -68220,8 +68726,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: - - *448 - - *449 + - *451 + - *452 - name: assignee in: path required: true @@ -68257,8 +68763,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -68370,8 +68876,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *102 - *103 @@ -68428,7 +68934,7 @@ paths: initiator: type: string examples: - default: *501 + default: *502 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68448,8 +68954,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -68457,7 +68963,7 @@ paths: application/json: schema: type: array - items: &502 + items: &503 title: Autolink reference description: An autolink reference. type: object @@ -68516,8 +69022,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -68556,9 +69062,9 @@ paths: description: response content: application/json: - schema: *502 + schema: *503 examples: - default: &503 + default: &504 value: id: 1 key_prefix: TICKET- @@ -68589,9 +69095,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: - - *448 - - *449 - - &504 + - *451 + - *452 + - &505 name: autolink_id description: The unique identifier of the autolink. in: path @@ -68603,9 +69109,9 @@ paths: description: Response content: application/json: - schema: *502 + schema: *503 examples: - default: *503 + default: *504 '404': *6 x-github: githubCloudOnly: false @@ -68625,9 +69131,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: - - *448 - - *449 - - *504 + - *451 + - *452 + - *505 responses: '204': description: Response @@ -68651,8 +69157,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response if Dependabot is enabled @@ -68702,8 +69208,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -68724,8 +69230,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -68745,8 +69251,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *448 - - *449 + - *451 + - *452 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -68784,7 +69290,7 @@ paths: - url protected: type: boolean - protection: &506 + protection: &507 title: Branch Protection description: Branch Protection type: object @@ -68827,7 +69333,7 @@ paths: required: - contexts - checks - enforce_admins: &509 + enforce_admins: &510 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -68844,7 +69350,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &511 + required_pull_request_reviews: &512 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -68866,7 +69372,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *296 + items: *300 apps: description: The list of apps with review dismissal access. @@ -68898,7 +69404,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *296 + items: *300 apps: description: The list of apps allowed to bypass pull request requirements. @@ -68928,7 +69434,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &508 + restrictions: &509 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -68991,7 +69497,7 @@ paths: type: string teams: type: array - items: *296 + items: *300 apps: type: array items: @@ -69221,9 +69727,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *448 - - *449 - - &507 + - *451 + - *452 + - &508 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). @@ -69237,14 +69743,14 @@ paths: description: Response content: application/json: - schema: &517 + schema: &518 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &564 + commit: &565 title: Commit description: Commit type: object @@ -69283,7 +69789,7 @@ paths: author: anyOf: - type: 'null' - - &505 + - &506 title: Git User description: Metaproperties for Git author/committer information. @@ -69304,7 +69810,7 @@ paths: committer: anyOf: - type: 'null' - - *505 + - *506 message: type: string examples: @@ -69328,7 +69834,7 @@ paths: required: - sha - url - verification: &622 + verification: &623 title: Verification type: object properties: @@ -69364,14 +69870,14 @@ paths: author: oneOf: - *4 - - *280 + - *284 type: - 'null' - object committer: oneOf: - *4 - - *280 + - *284 type: - 'null' - object @@ -69408,7 +69914,7 @@ paths: type: integer files: type: array - items: &575 + items: &576 title: Diff Entry description: Diff Entry type: object @@ -69504,7 +70010,7 @@ paths: - self protected: type: boolean - protection: *506 + protection: *507 protection_url: type: string format: uri @@ -69613,7 +70119,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *462 + '301': *463 '404': *6 x-github: githubCloudOnly: false @@ -69635,15 +70141,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response content: application/json: - schema: *506 + schema: *507 examples: default: value: @@ -69837,9 +70343,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: true content: @@ -70099,7 +70605,7 @@ paths: url: type: string format: uri - required_status_checks: &514 + required_status_checks: &515 title: Status Check Policy description: Status Check Policy type: object @@ -70180,7 +70686,7 @@ paths: items: *4 teams: type: array - items: *296 + items: *300 apps: type: array items: *5 @@ -70198,7 +70704,7 @@ paths: items: *4 teams: type: array - items: *296 + items: *300 apps: type: array items: *5 @@ -70258,7 +70764,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *508 + restrictions: *509 required_conversation_resolution: type: object properties: @@ -70370,9 +70876,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '204': description: Response @@ -70397,17 +70903,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response content: application/json: - schema: *509 + schema: *510 examples: - default: &510 + default: &511 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -70429,17 +70935,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response content: application/json: - schema: *509 + schema: *510 examples: - default: *510 + default: *511 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70458,9 +70964,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '204': description: Response @@ -70485,17 +70991,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response content: application/json: - schema: *511 + schema: *512 examples: - default: &512 + default: &513 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -70591,9 +71097,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: false content: @@ -70691,9 +71197,9 @@ paths: description: Response content: application/json: - schema: *511 + schema: *512 examples: - default: *512 + default: *513 '422': *15 x-github: githubCloudOnly: false @@ -70714,9 +71220,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '204': description: Response @@ -70743,17 +71249,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response content: application/json: - schema: *509 + schema: *510 examples: - default: &513 + default: &514 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -70776,17 +71282,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response content: application/json: - schema: *509 + schema: *510 examples: - default: *513 + default: *514 '404': *6 x-github: githubCloudOnly: false @@ -70806,9 +71312,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '204': description: Response @@ -70833,17 +71339,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response content: application/json: - schema: *514 + schema: *515 examples: - default: &515 + default: &516 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -70869,9 +71375,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: false content: @@ -70923,9 +71429,9 @@ paths: description: Response content: application/json: - schema: *514 + schema: *515 examples: - default: *515 + default: *516 '404': *6 '422': *15 x-github: @@ -70947,9 +71453,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '204': description: Response @@ -70973,9 +71479,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response @@ -71009,9 +71515,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: false content: @@ -71078,9 +71584,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: false content: @@ -71144,9 +71650,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: content: application/json: @@ -71212,15 +71718,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response content: application/json: - schema: *508 + schema: *509 examples: default: value: @@ -71311,9 +71817,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '204': description: Response @@ -71336,9 +71842,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: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response @@ -71348,7 +71854,7 @@ paths: type: array items: *5 examples: - default: &516 + default: &517 value: - id: 1 slug: octoapp @@ -71405,9 +71911,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: true content: @@ -71441,7 +71947,7 @@ paths: type: array items: *5 examples: - default: *516 + default: *517 '422': *15 x-github: githubCloudOnly: false @@ -71462,9 +71968,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: true content: @@ -71498,7 +72004,7 @@ paths: type: array items: *5 examples: - default: *516 + default: *517 '422': *15 x-github: githubCloudOnly: false @@ -71519,9 +72025,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: true content: @@ -71555,7 +72061,7 @@ paths: type: array items: *5 examples: - default: *516 + default: *517 '422': *15 x-github: githubCloudOnly: false @@ -71577,9 +72083,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: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response @@ -71587,9 +72093,9 @@ paths: application/json: schema: type: array - items: *296 + items: *300 examples: - default: *365 + default: *369 '404': *6 x-github: githubCloudOnly: false @@ -71609,9 +72115,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: false content: @@ -71647,9 +72153,9 @@ paths: application/json: schema: type: array - items: *296 + items: *300 examples: - default: *365 + default: *369 '422': *15 x-github: githubCloudOnly: false @@ -71670,9 +72176,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: false content: @@ -71708,9 +72214,9 @@ paths: application/json: schema: type: array - items: *296 + items: *300 examples: - default: *365 + default: *369 '422': *15 x-github: githubCloudOnly: false @@ -71731,9 +72237,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: content: application/json: @@ -71768,9 +72274,9 @@ paths: application/json: schema: type: array - items: *296 + items: *300 examples: - default: *365 + default: *369 '422': *15 x-github: githubCloudOnly: false @@ -71792,9 +72298,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: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 responses: '200': description: Response @@ -71804,7 +72310,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 '404': *6 x-github: githubCloudOnly: false @@ -71828,9 +72334,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: true content: @@ -71863,7 +72369,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 '422': *15 x-github: githubCloudOnly: false @@ -71888,9 +72394,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: true content: @@ -71923,7 +72429,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 '422': *15 x-github: githubCloudOnly: false @@ -71948,9 +72454,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: true content: @@ -71983,7 +72489,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 '422': *15 x-github: githubCloudOnly: false @@ -72010,9 +72516,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 requestBody: required: true content: @@ -72034,7 +72540,7 @@ paths: description: Response content: application/json: - schema: *517 + schema: *518 examples: default: value: @@ -72148,8 +72654,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *448 - - *449 + - *451 + - *452 - *97 - *98 - *99 @@ -72163,9 +72669,9 @@ paths: application/json: schema: type: array - items: *291 + items: *295 examples: - default: *292 + default: *296 '404': *6 '500': *38 "/repos/{owner}/{repo}/bypass-requests/push-rules/{bypass_request_number}": @@ -72185,8 +72691,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *448 - - *449 + - *451 + - *452 - name: bypass_request_number in: path required: true @@ -72200,7 +72706,7 @@ paths: description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -72259,8 +72765,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *448 - - *449 + - *451 + - *452 - *97 - *98 - *99 @@ -72274,9 +72780,9 @@ paths: application/json: schema: type: array - items: *294 + items: *298 examples: - default: *295 + default: *299 '404': *6 '403': *27 '500': *38 @@ -72300,8 +72806,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *448 - - *449 + - *451 + - *452 - name: bypass_request_number in: path required: true @@ -72313,7 +72819,7 @@ paths: description: A single bypass request. content: application/json: - schema: *294 + schema: *298 examples: default: value: @@ -72371,8 +72877,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *448 - - *449 + - *451 + - *452 - name: bypass_request_number in: path required: true @@ -72443,8 +72949,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *448 - - *449 + - *451 + - *452 - name: bypass_response_id in: path required: true @@ -72477,8 +72983,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -72757,7 +73263,7 @@ paths: description: Response content: application/json: - schema: &519 + schema: &520 title: CheckRun description: A check performed on the code of a given code change type: object @@ -72892,8 +73398,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *518 - deployment: &841 + items: *519 + deployment: &843 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -73180,9 +73686,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *448 - - *449 - - &520 + - *451 + - *452 + - &521 name: check_run_id description: The unique identifier of the check run. in: path @@ -73194,9 +73700,9 @@ paths: description: Response content: application/json: - schema: *519 + schema: *520 examples: - default: &521 + default: &522 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -73296,9 +73802,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *448 - - *449 - - *520 + - *451 + - *452 + - *521 requestBody: required: true content: @@ -73538,9 +74044,9 @@ paths: description: Response content: application/json: - schema: *519 + schema: *520 examples: - default: *521 + default: *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73560,9 +74066,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *448 - - *449 - - *520 + - *451 + - *452 + - *521 - *17 - *19 responses: @@ -73672,15 +74178,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *448 - - *449 - - *520 + - *451 + - *452 + - *521 responses: '201': description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -73718,8 +74224,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -73741,7 +74247,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &523 + schema: &524 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -73823,12 +74329,12 @@ paths: type: - array - 'null' - items: *518 + items: *519 app: anyOf: - type: 'null' - *5 - repository: *269 + repository: *273 created_at: type: - string @@ -73839,7 +74345,7 @@ paths: - string - 'null' format: date-time - head_commit: *522 + head_commit: *523 latest_check_runs_count: type: integer check_runs_url: @@ -73867,7 +74373,7 @@ paths: - check_runs_url - pull_requests examples: - default: &524 + default: &525 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -74158,9 +74664,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *523 + schema: *524 examples: - default: *524 + default: *525 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74179,8 +74685,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -74241,7 +74747,7 @@ paths: required: - app_id - setting - repository: *269 + repository: *273 examples: default: value: @@ -74489,9 +74995,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *448 - - *449 - - &525 + - *451 + - *452 + - &526 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -74503,9 +75009,9 @@ paths: description: Response content: application/json: - schema: *523 + schema: *524 examples: - default: *524 + default: *525 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74528,17 +75034,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: - - *448 - - *449 - - *525 - - &570 + - *451 + - *452 + - *526 + - &571 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &571 + - &572 name: status description: Returns check runs with the specified `status`. in: query @@ -74577,9 +75083,9 @@ paths: type: integer check_runs: type: array - items: *519 + items: *520 examples: - default: &572 + default: &573 value: total_count: 1 check_runs: @@ -74681,15 +75187,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *448 - - *449 - - *525 + - *451 + - *452 + - *526 responses: '201': description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -74716,21 +75222,21 @@ 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: - - *448 - - *449 - - *300 - - *301 + - *451 + - *452 + - *304 + - *305 - *19 - *17 - - &541 + - &542 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: *526 - - &542 + schema: *527 + - &543 name: pr description: The number of the pull request for the results you want to list. in: query @@ -74755,13 +75261,13 @@ paths: be returned. in: query required: false - schema: *302 + schema: *306 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *527 + schema: *528 responses: '200': description: Response @@ -74777,7 +75283,7 @@ paths: updated_at: *127 url: *124 html_url: *125 - instances_url: *528 + instances_url: *529 state: *107 fixed_at: *129 dismissed_by: @@ -74785,11 +75291,11 @@ paths: - type: 'null' - *4 dismissed_at: *128 - dismissed_reason: *529 - dismissed_comment: *530 - rule: *531 - tool: *532 - most_recent_instance: *533 + dismissed_reason: *530 + dismissed_comment: *531 + rule: *532 + tool: *533 + most_recent_instance: *534 dismissal_approved_by: anyOf: - type: 'null' @@ -74912,7 +75418,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &534 + '403': &535 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -74939,9 +75445,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: - - *448 - - *449 - - &535 + - *451 + - *452 + - &536 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -74955,7 +75461,7 @@ paths: description: Response content: application/json: - schema: &536 + schema: &537 type: object properties: number: *119 @@ -74963,7 +75469,7 @@ paths: updated_at: *127 url: *124 html_url: *125 - instances_url: *528 + instances_url: *529 state: *107 fixed_at: *129 dismissed_by: @@ -74971,8 +75477,8 @@ paths: - type: 'null' - *4 dismissed_at: *128 - dismissed_reason: *529 - dismissed_comment: *530 + dismissed_reason: *530 + dismissed_comment: *531 rule: type: object properties: @@ -75034,8 +75540,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *532 - most_recent_instance: *533 + tool: *533 + most_recent_instance: *534 dismissal_approved_by: anyOf: - type: 'null' @@ -75131,7 +75637,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *534 + '403': *535 '404': *6 '503': *184 x-github: @@ -75151,9 +75657,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: - - *448 - - *449 - - *535 + - *451 + - *452 + - *536 requestBody: required: true content: @@ -75168,8 +75674,8 @@ paths: enum: - open - dismissed - dismissed_reason: *529 - dismissed_comment: *530 + dismissed_reason: *530 + dismissed_comment: *531 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -75188,7 +75694,7 @@ paths: description: Response content: application/json: - schema: *536 + schema: *537 examples: default: value: @@ -75264,7 +75770,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &540 + '403': &541 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -75291,15 +75797,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: - - *448 - - *449 - - *535 + - *451 + - *452 + - *536 responses: '200': description: Response content: application/json: - schema: &537 + schema: &538 type: object properties: status: @@ -75326,13 +75832,13 @@ paths: - description - started_at examples: - default: &538 + default: &539 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &539 + '400': &540 description: Bad Request content: application/json: @@ -75343,7 +75849,7 @@ 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': *534 + '403': *535 '404': *6 '503': *184 x-github: @@ -75368,29 +75874,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: - - *448 - - *449 - - *535 + - *451 + - *452 + - *536 responses: '200': description: OK content: application/json: - schema: *537 + schema: *538 examples: - default: *538 + default: *539 '202': description: Accepted content: application/json: - schema: *537 + schema: *538 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *539 + '400': *540 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -75422,9 +75928,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: - - *448 - - *449 - - *535 + - *451 + - *452 + - *536 requestBody: required: false content: @@ -75470,8 +75976,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *539 - '403': *540 + '400': *540 + '403': *541 '404': *6 '422': description: Unprocessable Entity @@ -75495,13 +76001,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: - - *448 - - *449 - - *535 + - *451 + - *452 + - *536 - *19 - *17 - - *541 - *542 + - *543 responses: '200': description: Response @@ -75509,7 +76015,7 @@ paths: application/json: schema: type: array - items: *533 + items: *534 examples: default: value: @@ -75548,7 +76054,7 @@ paths: end_column: 50 classifications: - source - '403': *534 + '403': *535 '404': *6 '503': *184 x-github: @@ -75582,25 +76088,25 @@ 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: - - *448 - - *449 - - *300 - - *301 + - *451 + - *452 + - *304 + - *305 - *19 - *17 - - *542 + - *543 - 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: *526 + schema: *527 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &545 + schema: &546 type: string description: An identifier for the upload. examples: @@ -75622,23 +76128,23 @@ paths: application/json: schema: type: array - items: &546 + items: &547 type: object properties: - ref: *526 - commit_sha: &554 + ref: *527 + commit_sha: &555 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: *543 + analysis_key: *544 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *544 + category: *545 error: type: string examples: @@ -75663,8 +76169,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *545 - tool: *532 + sarif_id: *546 + tool: *533 deletable: type: boolean warning: @@ -75726,7 +76232,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *534 + '403': *535 '404': *6 '503': *184 x-github: @@ -75762,8 +76268,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: - - *448 - - *449 + - *451 + - *452 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -75776,7 +76282,7 @@ paths: description: Response content: application/json: - schema: *546 + schema: *547 examples: response: summary: application/json response @@ -75830,7 +76336,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *534 + '403': *535 '404': *6 '422': description: Response if analysis could not be processed @@ -75917,8 +76423,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: - - *448 - - *449 + - *451 + - *452 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -75974,7 +76480,7 @@ 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': *540 + '403': *541 '404': *6 '503': *184 x-github: @@ -75996,8 +76502,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -76005,7 +76511,7 @@ paths: application/json: schema: type: array - items: &547 + items: &548 title: CodeQL Database description: A CodeQL database. type: object @@ -76117,7 +76623,7 @@ 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': *534 + '403': *535 '404': *6 '503': *184 x-github: @@ -76146,8 +76652,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: - - *448 - - *449 + - *451 + - *452 - name: language in: path description: The language of the CodeQL database. @@ -76159,7 +76665,7 @@ paths: description: Response content: application/json: - schema: *547 + schema: *548 examples: default: value: @@ -76191,9 +76697,9 @@ 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': &577 + '302': &578 description: Found - '403': *534 + '403': *535 '404': *6 '503': *184 x-github: @@ -76215,8 +76721,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *448 - - *449 + - *451 + - *452 - name: language in: path description: The language of the CodeQL database. @@ -76226,7 +76732,7 @@ paths: responses: '204': description: Response - '403': *540 + '403': *541 '404': *6 '503': *184 x-github: @@ -76254,8 +76760,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -76264,7 +76770,7 @@ paths: type: object additionalProperties: false properties: - language: &548 + language: &549 type: string description: The language targeted by the CodeQL query enum: @@ -76343,7 +76849,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &552 + schema: &553 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -76353,7 +76859,7 @@ paths: description: The ID of the variant analysis. controller_repo: *113 actor: *4 - query_language: *548 + query_language: *549 query_pack_url: type: string description: The download url for the query pack. @@ -76401,7 +76907,7 @@ paths: items: type: object properties: - repository: &549 + repository: &550 title: Repository Identifier description: Repository Identifier type: object @@ -76443,7 +76949,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &553 + analysis_status: &554 type: string description: The new status of the CodeQL variant analysis repository task. @@ -76475,7 +76981,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &550 + access_mismatch_repos: &551 type: object properties: repository_count: @@ -76490,7 +76996,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: *549 + items: *550 required: - repository_count - repositories @@ -76513,8 +77019,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *550 - over_limit_repos: *550 + no_codeql_db_repos: *551 + over_limit_repos: *551 required: - access_mismatch_repos - not_found_repos @@ -76530,7 +77036,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &551 + value: &552 summary: Default response value: id: 1 @@ -76682,10 +77188,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *551 + value: *552 repository_lists: summary: Response for a successful variant analysis submission - value: *551 + value: *552 '404': *6 '422': description: Unable to process variant analysis submission @@ -76713,8 +77219,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: - - *448 - - *449 + - *451 + - *452 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -76726,9 +77232,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *553 examples: - default: *551 + default: *552 '404': *6 '503': *184 x-github: @@ -76751,7 +77257,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: - - *448 + - *451 - name: repo in: path description: The name of the controller repository. @@ -76786,7 +77292,7 @@ paths: type: object properties: repository: *113 - analysis_status: *553 + analysis_status: *554 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -76911,8 +77417,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -77005,7 +77511,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *534 + '403': *535 '404': *6 '503': *184 x-github: @@ -77026,8 +77532,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -77096,7 +77602,7 @@ paths: description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -77121,7 +77627,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *540 + '403': *541 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -77192,8 +77698,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -77201,7 +77707,7 @@ paths: schema: type: object properties: - commit_sha: *554 + commit_sha: *555 ref: type: string description: |- @@ -77261,7 +77767,7 @@ paths: schema: type: object properties: - id: *545 + id: *546 url: type: string description: The REST API URL for checking the status of the upload. @@ -77275,7 +77781,7 @@ 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': *540 + '403': *541 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -77298,8 +77804,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: - - *448 - - *449 + - *451 + - *452 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -77347,7 +77853,7 @@ 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': *534 + '403': *535 '404': description: Not Found if the sarif id does not match any upload '503': *184 @@ -77372,8 +77878,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -77454,8 +77960,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *448 - - *449 + - *451 + - *452 - 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 @@ -77583,8 +78089,8 @@ paths: parameters: - *17 - *19 - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -77600,7 +78106,7 @@ paths: type: integer codespaces: type: array - items: *356 + items: *360 examples: default: value: @@ -77898,8 +78404,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -77963,17 +78469,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '400': *14 '401': *23 '403': *27 @@ -78002,8 +78508,8 @@ paths: parameters: - *17 - *19 - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -78067,8 +78573,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: - - *448 - - *449 + - *451 + - *452 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -78105,9 +78611,9 @@ paths: type: integer machines: type: array - items: *556 + items: *557 examples: - default: &793 + default: &795 value: total_count: 2 machines: @@ -78147,8 +78653,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *448 - - *449 + - *451 + - *452 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -78235,8 +78741,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: - - *448 - - *449 + - *451 + - *452 - 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 @@ -78305,8 +78811,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -78324,7 +78830,7 @@ paths: type: integer secrets: type: array - items: &560 + items: &561 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -78345,7 +78851,7 @@ paths: - created_at - updated_at examples: - default: *557 + default: *558 headers: Link: *41 x-github: @@ -78368,16 +78874,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *558 + schema: *559 examples: - default: *559 + default: *560 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -78397,17 +78903,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *448 - - *449 - - *279 + - *451 + - *452 + - *283 responses: '200': description: Response content: application/json: - schema: *560 + schema: *561 examples: - default: *561 + default: *562 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78427,9 +78933,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: - - *448 - - *449 - - *279 + - *451 + - *452 + - *283 requestBody: required: true content: @@ -78457,7 +78963,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -78481,9 +78987,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *448 - - *449 - - *279 + - *451 + - *452 + - *283 responses: '204': description: Response @@ -78511,8 +79017,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *448 - - *449 + - *451 + - *452 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -78550,7 +79056,7 @@ paths: application/json: schema: type: array - items: &562 + items: &563 title: Collaborator description: Collaborator type: object @@ -78743,8 +79249,8 @@ 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: - - *448 - - *449 + - *451 + - *452 - *132 responses: '204': @@ -78791,8 +79297,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *448 - - *449 + - *451 + - *452 - *132 requestBody: required: false @@ -78819,7 +79325,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &635 + schema: &636 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -78831,7 +79337,7 @@ paths: format: int64 examples: - 42 - repository: *269 + repository: *273 invitee: anyOf: - type: 'null' @@ -79007,7 +79513,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *244 + schema: *248 '403': *27 x-github: triggersNotification: true @@ -79047,8 +79553,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *448 - - *449 + - *451 + - *452 - *132 responses: '204': @@ -79080,8 +79586,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *448 - - *449 + - *451 + - *452 - *132 responses: '200': @@ -79102,7 +79608,7 @@ paths: user: anyOf: - type: 'null' - - *562 + - *563 required: - permission - role_name @@ -79156,8 +79662,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -79167,7 +79673,7 @@ paths: application/json: schema: type: array - items: &563 + items: &564 title: Commit Comment description: Commit Comment type: object @@ -79208,8 +79714,8 @@ paths: updated_at: type: string format: date-time - author_association: *205 - reactions: *206 + author_association: *206 + reactions: *207 required: - url - html_url @@ -79225,7 +79731,7 @@ paths: - created_at - updated_at examples: - default: &566 + default: &567 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -79284,17 +79790,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 responses: '200': description: Response content: application/json: - schema: *563 + schema: *564 examples: - default: &567 + default: &568 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -79351,9 +79857,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 requestBody: required: true content: @@ -79375,7 +79881,7 @@ paths: description: Response content: application/json: - schema: *563 + schema: *564 examples: default: value: @@ -79426,9 +79932,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 responses: '204': description: Response @@ -79449,9 +79955,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 - 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. @@ -79477,9 +79983,9 @@ paths: application/json: schema: type: array - items: *437 + items: *440 examples: - default: *439 + default: *442 headers: Link: *41 '404': *6 @@ -79500,9 +80006,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 requestBody: required: true content: @@ -79534,16 +80040,16 @@ paths: description: Reaction exists content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '201': description: Reaction created content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '422': *15 x-github: githubCloudOnly: false @@ -79565,10 +80071,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *448 - - *449 - - *217 - - *440 + - *451 + - *452 + - *218 + - *443 responses: '204': description: Response @@ -79617,8 +80123,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *448 - - *449 + - *451 + - *452 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -79674,9 +80180,9 @@ paths: application/json: schema: type: array - items: *564 + items: *565 examples: - default: &684 + default: &686 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -79770,9 +80276,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *448 - - *449 - - &565 + - *451 + - *452 + - &566 name: commit_sha description: The SHA of the commit. in: path @@ -79844,9 +80350,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *448 - - *449 - - *565 + - *451 + - *452 + - *566 - *17 - *19 responses: @@ -79856,9 +80362,9 @@ paths: application/json: schema: type: array - items: *563 + items: *564 examples: - default: *566 + default: *567 headers: Link: *41 x-github: @@ -79886,9 +80392,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *448 - - *449 - - *565 + - *451 + - *452 + - *566 requestBody: required: true content: @@ -79923,9 +80429,9 @@ paths: description: Response content: application/json: - schema: *563 + schema: *564 examples: - default: *567 + default: *568 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -79953,9 +80459,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: - - *448 - - *449 - - *565 + - *451 + - *452 + - *566 - *17 - *19 responses: @@ -79965,9 +80471,9 @@ paths: application/json: schema: type: array - items: *568 + items: *569 examples: - default: &676 + default: &678 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -80504,11 +81010,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *448 - - *449 + - *451 + - *452 - *19 - *17 - - &569 + - &570 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)" @@ -80523,9 +81029,9 @@ paths: description: Response content: application/json: - schema: *564 + schema: *565 examples: - default: &662 + default: &664 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -80638,11 +81144,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: - - *448 - - *449 - - *569 + - *451 + - *452 - *570 - *571 + - *572 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -80676,9 +81182,9 @@ paths: type: integer check_runs: type: array - items: *519 + items: *520 examples: - default: *572 + default: *573 headers: Link: *41 x-github: @@ -80703,9 +81209,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: - - *448 - - *449 - - *569 + - *451 + - *452 + - *570 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -80713,7 +81219,7 @@ paths: schema: type: integer example: 1 - - *570 + - *571 - *17 - *19 responses: @@ -80731,7 +81237,7 @@ paths: type: integer check_suites: type: array - items: *523 + items: *524 examples: default: value: @@ -80931,9 +81437,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: - - *448 - - *449 - - *569 + - *451 + - *452 + - *570 - *17 - *19 responses: @@ -81004,7 +81510,7 @@ paths: type: string total_count: type: integer - repository: *269 + repository: *273 commit_url: type: string format: uri @@ -81135,9 +81641,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *448 - - *449 - - *569 + - *451 + - *452 + - *570 - *17 - *19 responses: @@ -81147,7 +81653,7 @@ paths: application/json: schema: type: array - items: &738 + items: &740 title: Status description: The status of a commit. type: object @@ -81228,7 +81734,7 @@ paths: site_admin: false headers: Link: *41 - '301': *462 + '301': *463 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81256,8 +81762,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -81290,11 +81796,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *573 + - *574 code_of_conduct_file: anyOf: - type: 'null' - - &574 + - &575 title: Community Health File type: object properties: @@ -81310,23 +81816,23 @@ paths: license: anyOf: - type: 'null' - - *219 + - *220 contributing: anyOf: - type: 'null' - - *574 + - *575 readme: anyOf: - type: 'null' - - *574 + - *575 issue_template: anyOf: - type: 'null' - - *574 + - *575 pull_request_template: anyOf: - type: 'null' - - *574 + - *575 required: - code_of_conduct - code_of_conduct_file @@ -81455,8 +81961,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *448 - - *449 + - *451 + - *452 - *19 - *17 - name: basehead @@ -81504,8 +82010,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *564 - merge_base_commit: *564 + base_commit: *565 + merge_base_commit: *565 status: type: string enum: @@ -81529,10 +82035,10 @@ paths: - 6 commits: type: array - items: *564 + items: *565 files: type: array - items: *575 + items: *576 required: - url - html_url @@ -81818,8 +82324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *448 - - *449 + - *451 + - *452 - name: path description: path parameter in: path @@ -81972,7 +82478,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &576 + response-if-content-is-a-file: &577 summary: Response if content is a file value: type: file @@ -82109,7 +82615,7 @@ paths: - size - type - url - - &689 + - &691 title: Content File description: Content File type: object @@ -82327,7 +82833,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *576 + response-if-content-is-a-file: *577 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -82396,7 +82902,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *577 + '302': *578 '304': *35 x-github: githubCloudOnly: false @@ -82419,8 +82925,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *448 - - *449 + - *451 + - *452 - name: path description: path parameter in: path @@ -82515,7 +83021,7 @@ paths: description: Response content: application/json: - schema: &578 + schema: &579 title: File Commit description: File Commit type: object @@ -82671,7 +83177,7 @@ paths: description: Response content: application/json: - schema: *578 + schema: *579 examples: example-for-creating-a-file: value: @@ -82725,7 +83231,7 @@ paths: schema: oneOf: - *3 - - &617 + - &618 description: Repository rule violation was detected type: object properties: @@ -82746,7 +83252,7 @@ paths: items: type: object properties: - placeholder_id: &730 + placeholder_id: &732 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -82778,8 +83284,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *448 - - *449 + - *451 + - *452 - name: path description: path parameter in: path @@ -82840,7 +83346,7 @@ paths: description: Response content: application/json: - schema: *578 + schema: *579 examples: default: value: @@ -82895,8 +83401,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *448 - - *449 + - *451 + - *452 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -83020,22 +83526,22 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *448 - - *449 - - *316 - - *317 - - *318 - - *319 + - *451 + - *452 + - *320 + - *321 + - *322 + - *323 - 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 - - *320 - - *579 - - *321 - - *322 + - *324 + - *580 + - *325 + - *326 - *104 - name: per_page description: The number of results per page (max 100). For more information, @@ -83054,7 +83560,7 @@ paths: application/json: schema: type: array - items: &582 + items: &583 type: object description: A Dependabot alert. properties: @@ -83104,7 +83610,7 @@ paths: - direct - transitive - - security_advisory: *580 + security_advisory: *581 security_vulnerability: *123 url: *124 html_url: *125 @@ -83135,7 +83641,7 @@ paths: dismissal. maxLength: 280 fixed_at: *129 - auto_dismissed_at: *581 + auto_dismissed_at: *582 required: - number - state @@ -83365,9 +83871,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *448 - - *449 - - &583 + - *451 + - *452 + - &584 name: alert_number in: path description: |- @@ -83382,7 +83888,7 @@ paths: description: Response content: application/json: - schema: *582 + schema: *583 examples: default: value: @@ -83495,9 +84001,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *448 - - *449 - - *583 + - *451 + - *452 + - *584 requestBody: required: true content: @@ -83542,7 +84048,7 @@ paths: description: Response content: application/json: - schema: *582 + schema: *583 examples: default: value: @@ -83671,8 +84177,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -83690,7 +84196,7 @@ paths: type: integer secrets: type: array - items: &586 + items: &587 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -83744,16 +84250,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *584 + schema: *585 examples: - default: *585 + default: *586 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83773,15 +84279,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *448 - - *449 - - *279 + - *451 + - *452 + - *283 responses: '200': description: Response content: application/json: - schema: *586 + schema: *587 examples: default: value: @@ -83807,9 +84313,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *448 - - *449 - - *279 + - *451 + - *452 + - *283 requestBody: required: true content: @@ -83837,7 +84343,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -83861,9 +84367,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *448 - - *449 - - *279 + - *451 + - *452 + - *283 responses: '204': description: Response @@ -83885,8 +84391,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: - - *448 - - *449 + - *451 + - *452 - 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 @@ -84060,8 +84566,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -84321,8 +84827,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -84405,7 +84911,7 @@ paths: - version - url additionalProperties: false - metadata: &587 + metadata: &588 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -84444,7 +84950,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *587 + metadata: *588 resolved: type: object description: A collection of resolved package dependencies. @@ -84458,7 +84964,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *587 + metadata: *588 relationship: type: string description: A notation of whether a dependency is requested @@ -84591,8 +85097,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *448 - - *449 + - *451 + - *452 - name: sha description: The SHA recorded at creation time. in: query @@ -84633,9 +85139,9 @@ paths: application/json: schema: type: array - items: *588 + items: *589 examples: - default: *589 + default: *590 headers: Link: *41 x-github: @@ -84701,8 +85207,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -84784,7 +85290,7 @@ paths: description: Response content: application/json: - schema: *588 + schema: *589 examples: simple-example: summary: Simple example @@ -84857,9 +85363,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *448 - - *449 - - &590 + - *451 + - *452 + - &591 name: deployment_id description: deployment_id parameter in: path @@ -84871,7 +85377,7 @@ paths: description: Response content: application/json: - schema: *588 + schema: *589 examples: default: value: @@ -84936,9 +85442,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *448 - - *449 - - *590 + - *451 + - *452 + - *591 responses: '204': description: Response @@ -84960,9 +85466,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *448 - - *449 - - *590 + - *451 + - *452 + - *591 - *17 - *19 responses: @@ -84972,7 +85478,7 @@ paths: application/json: schema: type: array - items: &591 + items: &592 title: Deployment Status description: The status of a deployment. type: object @@ -85136,9 +85642,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *448 - - *449 - - *590 + - *451 + - *452 + - *591 requestBody: required: true content: @@ -85213,9 +85719,9 @@ paths: description: Response content: application/json: - schema: *591 + schema: *592 examples: - default: &592 + default: &593 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -85271,9 +85777,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *448 - - *449 - - *590 + - *451 + - *452 + - *591 - name: status_id in: path required: true @@ -85284,9 +85790,9 @@ paths: description: Response content: application/json: - schema: *591 + schema: *592 examples: - default: *592 + default: *593 '404': *6 x-github: githubCloudOnly: false @@ -85313,12 +85819,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 - - *593 + - *451 + - *452 - *594 - *595 - *596 + - *597 - *17 - *19 responses: @@ -85328,9 +85834,9 @@ paths: application/json: schema: type: array - items: *597 + items: *598 examples: - default: *598 + default: *599 '404': *6 '403': *27 '500': *38 @@ -85354,8 +85860,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *451 + - *452 - name: alert_number in: path required: true @@ -85367,7 +85873,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *597 + schema: *598 examples: default: value: @@ -85423,8 +85929,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *451 + - *452 - name: alert_number in: path required: true @@ -85483,12 +85989,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *451 + - *452 - *97 - *98 - *99 - - *599 + - *600 - *17 - *19 responses: @@ -85498,9 +86004,9 @@ paths: application/json: schema: type: array - items: *600 + items: *601 examples: - default: *601 + default: *602 '404': *6 '403': *27 '500': *38 @@ -85525,8 +86031,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *451 + - *452 - name: alert_number in: path required: true @@ -85538,7 +86044,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *600 + schema: *601 examples: default: value: @@ -85596,8 +86102,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *448 - - *449 + - *451 + - *452 - name: alert_number in: path required: true @@ -85666,8 +86172,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -85724,8 +86230,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -85743,7 +86249,7 @@ paths: - 5 environments: type: array - items: &603 + items: &604 title: Environment description: Details of a deployment environment type: object @@ -85805,7 +86311,7 @@ paths: type: string examples: - wait_timer - wait_timer: &605 + wait_timer: &606 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -85847,11 +86353,11 @@ paths: items: type: object properties: - type: *602 + type: *603 reviewer: anyOf: - *4 - - *296 + - *300 required: - id - node_id @@ -85874,7 +86380,7 @@ paths: - id - node_id - type - deployment_branch_policy: &606 + deployment_branch_policy: &607 type: - object - 'null' @@ -85991,9 +86497,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *448 - - *449 - - &604 + - *451 + - *452 + - &605 name: environment_name in: path required: true @@ -86006,9 +86512,9 @@ paths: description: Response content: application/json: - schema: *603 + schema: *604 examples: - default: &607 + default: &608 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -86092,9 +86598,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *448 - - *449 - - *604 + - *451 + - *452 + - *605 requestBody: required: false content: @@ -86104,7 +86610,7 @@ paths: - object - 'null' properties: - wait_timer: *605 + wait_timer: *606 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -86123,14 +86629,14 @@ paths: items: type: object properties: - type: *602 + type: *603 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *606 + deployment_branch_policy: *607 additionalProperties: false examples: default: @@ -86150,9 +86656,9 @@ paths: description: Response content: application/json: - schema: *603 + schema: *604 examples: - default: *607 + default: *608 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -86176,9 +86682,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *448 - - *449 - - *604 + - *451 + - *452 + - *605 responses: '204': description: Default response @@ -86203,9 +86709,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *448 - - *449 - - *604 + - *451 + - *452 + - *605 - *17 - *19 responses: @@ -86224,7 +86730,7 @@ paths: - 2 branch_policies: type: array - items: &608 + items: &609 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -86285,9 +86791,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *448 - - *449 - - *604 + - *451 + - *452 + - *605 requestBody: required: true content: @@ -86335,9 +86841,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *609 examples: - example-wildcard: &609 + example-wildcard: &610 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -86379,10 +86885,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *448 - - *449 - - *604 - - &610 + - *451 + - *452 + - *605 + - &611 name: branch_policy_id in: path required: true @@ -86394,9 +86900,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *609 examples: - default: *609 + default: *610 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86415,10 +86921,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *448 - - *449 - - *604 - - *610 + - *451 + - *452 + - *605 + - *611 requestBody: required: true content: @@ -86447,9 +86953,9 @@ paths: description: Response content: application/json: - schema: *608 + schema: *609 examples: - default: *609 + default: *610 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86468,10 +86974,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *448 - - *449 - - *604 - - *610 + - *451 + - *452 + - *605 + - *611 responses: '204': description: Response @@ -86496,9 +87002,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: - - *604 - - *449 - - *448 + - *605 + - *452 + - *451 responses: '200': description: List of deployment protection rules @@ -86515,7 +87021,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &611 + items: &612 title: Deployment protection rule description: Deployment protection rule type: object @@ -86537,7 +87043,7 @@ paths: for the environment. examples: - true - app: &612 + app: &613 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -86640,9 +87146,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: - - *604 - - *449 - - *448 + - *605 + - *452 + - *451 requestBody: content: application/json: @@ -86663,9 +87169,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *611 + schema: *612 examples: - default: &613 + default: &614 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -86700,9 +87206,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: - - *604 - - *449 - - *448 + - *605 + - *452 + - *451 - *19 - *17 responses: @@ -86722,7 +87228,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *612 + items: *613 examples: default: value: @@ -86757,10 +87263,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: - - *448 - - *449 - - *604 - - &614 + - *451 + - *452 + - *605 + - &615 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -86772,9 +87278,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *612 examples: - default: *613 + default: *614 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86795,10 +87301,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: - - *604 - - *449 - - *448 - - *614 + - *605 + - *452 + - *451 + - *615 responses: '204': description: Response @@ -86824,9 +87330,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *448 - - *449 - - *604 + - *451 + - *452 + - *605 - *17 - *19 responses: @@ -86844,9 +87350,9 @@ paths: type: integer secrets: type: array - items: *485 + items: *486 examples: - default: *486 + default: *487 headers: Link: *41 x-github: @@ -86871,17 +87377,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *448 - - *449 - - *604 + - *451 + - *452 + - *605 responses: '200': description: Response content: application/json: - schema: *487 + schema: *488 examples: - default: *488 + default: *489 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86903,18 +87409,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *448 - - *449 - - *604 - - *279 + - *451 + - *452 + - *605 + - *283 responses: '200': description: Response content: application/json: - schema: *485 + schema: *486 examples: - default: *615 + default: *616 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86936,10 +87442,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *448 - - *449 - - *604 - - *279 + - *451 + - *452 + - *605 + - *283 requestBody: required: true content: @@ -86970,7 +87476,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -86996,10 +87502,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *448 - - *449 - - *604 - - *279 + - *451 + - *452 + - *605 + - *283 responses: '204': description: Default response @@ -87024,10 +87530,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *448 - - *449 - - *604 - - *472 + - *451 + - *452 + - *605 + - *473 - *19 responses: '200': @@ -87044,9 +87550,9 @@ paths: type: integer variables: type: array - items: *489 + items: *490 examples: - default: *490 + default: *491 headers: Link: *41 x-github: @@ -87069,9 +87575,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *448 - - *449 - - *604 + - *451 + - *452 + - *605 requestBody: required: true content: @@ -87098,7 +87604,7 @@ paths: description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -87123,18 +87629,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *448 - - *449 - - *604 - - *282 + - *451 + - *452 + - *605 + - *286 responses: '200': description: Response content: application/json: - schema: *489 + schema: *490 examples: - default: *616 + default: *617 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87155,10 +87661,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *448 - - *449 - - *282 - - *604 + - *451 + - *452 + - *286 + - *605 requestBody: required: true content: @@ -87200,10 +87706,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *448 - - *449 - - *282 - - *604 + - *451 + - *452 + - *286 + - *605 responses: '204': description: Response @@ -87225,8 +87731,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -87236,7 +87742,7 @@ paths: application/json: schema: type: array - items: *229 + items: *230 examples: 200-response: value: @@ -87294,8 +87800,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *448 - - *449 + - *451 + - *452 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -87317,7 +87823,7 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: default: value: @@ -87454,8 +87960,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: false content: @@ -87488,9 +87994,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *462 examples: - default: *463 + default: *464 '400': *14 '422': *15 '403': *27 @@ -87511,8 +88017,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -87571,8 +88077,8 @@ paths: application/json: schema: oneOf: - - *244 - - *617 + - *248 + - *618 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87597,8 +88103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *448 - - *449 + - *451 + - *452 - name: file_sha in: path required: true @@ -87698,8 +88204,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -87808,7 +88314,7 @@ paths: description: Response content: application/json: - schema: &618 + schema: &619 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -88035,15 +88541,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *448 - - *449 - - *565 + - *451 + - *452 + - *566 responses: '200': description: Response content: application/json: - schema: *618 + schema: *619 examples: default: value: @@ -88099,9 +88605,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *448 - - *449 - - &619 + - *451 + - *452 + - &620 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. @@ -88118,7 +88624,7 @@ paths: application/json: schema: type: array - items: &620 + items: &621 title: Git Reference description: Git references within a repository type: object @@ -88194,17 +88700,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *448 - - *449 - - *619 + - *451 + - *452 + - *620 responses: '200': description: Response content: application/json: - schema: *620 + schema: *621 examples: - default: &621 + default: &622 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -88233,8 +88739,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -88263,9 +88769,9 @@ paths: description: Response content: application/json: - schema: *620 + schema: *621 examples: - default: *621 + default: *622 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -88291,9 +88797,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *448 - - *449 - - *619 + - *451 + - *452 + - *620 requestBody: required: true content: @@ -88322,9 +88828,9 @@ paths: description: Response content: application/json: - schema: *620 + schema: *621 examples: - default: *621 + default: *622 '422': *15 '409': *112 x-github: @@ -88342,9 +88848,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *448 - - *449 - - *619 + - *451 + - *452 + - *620 responses: '204': description: Response @@ -88399,8 +88905,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -88467,7 +88973,7 @@ paths: description: Response content: application/json: - schema: &623 + schema: &624 title: Git Tag description: Metadata for a Git tag type: object @@ -88523,7 +89029,7 @@ paths: - sha - type - url - verification: *622 + verification: *623 required: - sha - url @@ -88533,7 +89039,7 @@ paths: - tag - message examples: - default: &624 + default: &625 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -88606,8 +89112,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *448 - - *449 + - *451 + - *452 - name: tag_sha in: path required: true @@ -88618,9 +89124,9 @@ paths: description: Response content: application/json: - schema: *623 + schema: *624 examples: - default: *624 + default: *625 '404': *6 '409': *112 x-github: @@ -88644,8 +89150,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -88719,7 +89225,7 @@ paths: description: Response content: application/json: - schema: &625 + schema: &626 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -88821,8 +89327,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *448 - - *449 + - *451 + - *452 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -88845,7 +89351,7 @@ paths: description: Response content: application/json: - schema: *625 + schema: *626 examples: default-response: summary: Default response @@ -88904,8 +89410,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -88915,7 +89421,7 @@ paths: application/json: schema: type: array - items: &626 + items: &627 title: Webhook description: Webhooks for repositories. type: object @@ -88978,7 +89484,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &872 + last_response: &874 title: Hook Response type: object properties: @@ -89055,8 +89561,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: false content: @@ -89109,9 +89615,9 @@ paths: description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: &627 + default: &628 value: type: Repository id: 12345678 @@ -89159,17 +89665,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 responses: '200': description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: *627 + default: *628 '404': *6 x-github: githubCloudOnly: false @@ -89189,9 +89695,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 requestBody: required: true content: @@ -89236,9 +89742,9 @@ paths: description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: *627 + default: *628 '422': *15 '404': *6 x-github: @@ -89259,9 +89765,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 responses: '204': description: Response @@ -89285,9 +89791,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: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 responses: '200': description: Response @@ -89314,9 +89820,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: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 requestBody: required: false content: @@ -89360,11 +89866,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 - *17 - - *329 + - *333 responses: '200': description: Response @@ -89372,9 +89878,9 @@ paths: application/json: schema: type: array - items: *330 + items: *334 examples: - default: *331 + default: *335 '400': *14 '422': *15 x-github: @@ -89393,18 +89899,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: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 - *16 responses: '200': description: Response content: application/json: - schema: *332 + schema: *336 examples: - default: *333 + default: *337 '400': *14 '422': *15 x-github: @@ -89423,9 +89929,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: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 - *16 responses: '202': *37 @@ -89448,9 +89954,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 responses: '204': description: Response @@ -89475,9 +89981,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *448 - - *449 - - *328 + - *451 + - *452 + - *332 responses: '204': description: Response @@ -89500,8 +90006,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response if immutable releases are enabled @@ -89549,8 +90055,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': *144 '409': *112 @@ -89570,8 +90076,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': *144 '409': *112 @@ -89628,14 +90134,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: &628 + schema: &629 title: Import description: A repository import from an external source. type: object @@ -89742,7 +90248,7 @@ paths: - html_url - authors_url examples: - default: &631 + default: &632 value: vcs: subversion use_lfs: true @@ -89758,7 +90264,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': &629 + '503': &630 description: Unavailable due to service under maintenance. content: application/json: @@ -89787,8 +90293,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -89836,7 +90342,7 @@ paths: description: Response content: application/json: - schema: *628 + schema: *629 examples: default: value: @@ -89861,7 +90367,7 @@ paths: type: string '422': *15 '404': *6 - '503': *629 + '503': *630 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89889,8 +90395,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: false content: @@ -89942,7 +90448,7 @@ paths: description: Response content: application/json: - schema: *628 + schema: *629 examples: example-1: summary: Example 1 @@ -89990,7 +90496,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': *629 + '503': *630 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90013,12 +90519,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response - '503': *629 + '503': *630 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90044,9 +90550,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *448 - - *449 - - &814 + - *451 + - *452 + - &816 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -90060,7 +90566,7 @@ paths: application/json: schema: type: array - items: &630 + items: &631 title: Porter Author description: Porter Author type: object @@ -90114,7 +90620,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': *629 + '503': *630 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90139,8 +90645,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *448 - - *449 + - *451 + - *452 - name: author_id in: path required: true @@ -90170,7 +90676,7 @@ paths: description: Response content: application/json: - schema: *630 + schema: *631 examples: default: value: @@ -90183,7 +90689,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *629 + '503': *630 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90207,8 +90713,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -90249,7 +90755,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *629 + '503': *630 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90277,8 +90783,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -90305,11 +90811,11 @@ paths: description: Response content: application/json: - schema: *628 + schema: *629 examples: - default: *631 + default: *632 '422': *15 - '503': *629 + '503': *630 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90332,8 +90838,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -90341,8 +90847,8 @@ paths: application/json: schema: *20 examples: - default: *632 - '301': *462 + default: *633 + '301': *463 '404': *6 x-github: githubCloudOnly: false @@ -90362,8 +90868,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -90371,12 +90877,12 @@ paths: application/json: schema: anyOf: - - *346 + - *350 - type: object properties: {} additionalProperties: false examples: - default: &634 + default: &635 value: limit: collaborators_only origin: repository @@ -90401,13 +90907,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: application/json: - schema: *633 + schema: *634 examples: default: summary: Example request body @@ -90419,9 +90925,9 @@ paths: description: Response content: application/json: - schema: *346 + schema: *350 examples: - default: *634 + default: *635 '409': description: Response x-github: @@ -90443,8 +90949,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -90467,8 +90973,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -90478,9 +90984,9 @@ paths: application/json: schema: type: array - items: *635 + items: *636 examples: - default: &807 + default: &809 value: - id: 1 repository: @@ -90611,9 +91117,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *448 - - *449 - - *350 + - *451 + - *452 + - *354 requestBody: required: false content: @@ -90642,7 +91148,7 @@ paths: description: Response content: application/json: - schema: *635 + schema: *636 examples: default: value: @@ -90773,9 +91279,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *448 - - *449 - - *350 + - *451 + - *452 + - *354 responses: '204': description: Response @@ -90806,8 +91312,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *448 - - *449 + - *451 + - *452 - 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 @@ -90855,7 +91361,7 @@ paths: required: false schema: type: string - - *354 + - *358 - name: sort description: What to sort results by. in: query @@ -90868,7 +91374,7 @@ paths: - comments default: created - *104 - - *208 + - *209 - *17 - *19 responses: @@ -90878,9 +91384,9 @@ paths: application/json: schema: type: array - items: *218 + items: *219 examples: - default: &642 + default: &644 value: - id: 1 node_id: MDU6SXNzdWUx @@ -91028,7 +91534,7 @@ paths: state_reason: completed headers: Link: *41 - '301': *462 + '301': *463 '422': *15 '404': *6 x-github: @@ -91057,8 +91563,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -91148,9 +91654,9 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: &639 + default: &641 value: id: 1 node_id: MDU6SXNzdWUx @@ -91306,7 +91812,7 @@ paths: '422': *15 '503': *184 '404': *6 - '410': *459 + '410': *637 x-github: triggersNotification: true githubCloudOnly: false @@ -91334,9 +91840,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *448 - - *449 - - *227 + - *451 + - *452 + - *228 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -91346,7 +91852,7 @@ paths: enum: - asc - desc - - *208 + - *209 - *17 - *19 responses: @@ -91356,9 +91862,9 @@ paths: application/json: schema: type: array - items: *636 + items: *638 examples: - default: &641 + default: &643 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -91416,17 +91922,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 responses: '200': description: Response content: application/json: - schema: *636 + schema: *638 examples: - default: &637 + default: &639 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -91480,9 +91986,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 requestBody: required: true content: @@ -91504,9 +92010,9 @@ paths: description: Response content: application/json: - schema: *636 + schema: *638 examples: - default: *637 + default: *639 '422': *15 x-github: githubCloudOnly: false @@ -91524,9 +92030,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 responses: '204': description: Response @@ -91546,9 +92052,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 - 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. @@ -91574,9 +92080,9 @@ paths: application/json: schema: type: array - items: *437 + items: *440 examples: - default: *439 + default: *442 headers: Link: *41 '404': *6 @@ -91597,9 +92103,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 requestBody: required: true content: @@ -91631,16 +92137,16 @@ paths: description: Reaction exists content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '201': description: Reaction created content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '422': *15 x-github: githubCloudOnly: false @@ -91662,10 +92168,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *448 - - *449 - - *217 - - *440 + - *451 + - *452 + - *218 + - *443 responses: '204': description: Response @@ -91685,8 +92191,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -91696,7 +92202,7 @@ paths: application/json: schema: type: array - items: &638 + items: &640 title: Issue Event description: Issue Event type: object @@ -91743,7 +92249,7 @@ paths: issue: anyOf: - type: 'null' - - *218 + - *219 label: title: Issue Event Label description: Issue Event Label @@ -91776,7 +92282,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *296 + requested_team: *300 dismissed_review: title: Issue Event Dismissed Review type: object @@ -91843,7 +92349,7 @@ paths: required: - from - to - author_association: *205 + author_association: *206 lock_reason: type: - string @@ -92035,8 +92541,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *448 - - *449 + - *451 + - *452 - name: event_id in: path required: true @@ -92047,7 +92553,7 @@ paths: description: Response content: application/json: - schema: *638 + schema: *640 examples: default: value: @@ -92240,7 +92746,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *459 + '410': *637 '403': *27 x-github: githubCloudOnly: false @@ -92274,9 +92780,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *448 - - *449 - - &640 + - *451 + - *452 + - &642 name: issue_number description: The number that identifies the issue. in: path @@ -92288,12 +92794,12 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 - '301': *462 + default: *641 + '301': *463 '404': *6 - '410': *459 + '410': *637 '304': *35 x-github: githubCloudOnly: false @@ -92318,9 +92824,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: false content: @@ -92439,15 +92945,15 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 + default: *641 '422': *15 '503': *184 '403': *27 - '301': *462 + '301': *463 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92465,9 +92971,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: false content: @@ -92493,9 +92999,9 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 + default: *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92511,9 +93017,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: content: application/json: @@ -92538,9 +93044,9 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 + default: *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92562,9 +93068,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: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - name: assignee in: path required: true @@ -92604,10 +93110,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *448 - - *449 - - *640 - - *208 + - *451 + - *452 + - *642 + - *209 - *17 - *19 responses: @@ -92617,13 +93123,13 @@ paths: application/json: schema: type: array - items: *636 + items: *638 examples: - default: *641 + default: *643 headers: Link: *41 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92652,9 +93158,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: true content: @@ -92676,16 +93182,16 @@ paths: description: Response content: application/json: - schema: *636 + schema: *638 examples: - default: *637 + default: *639 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *459 + '410': *637 '422': *15 '404': *6 x-github: @@ -92713,9 +93219,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: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - *17 - *19 responses: @@ -92725,14 +93231,14 @@ paths: application/json: schema: type: array - items: *218 + items: *219 examples: - default: *642 + default: *644 headers: Link: *41 - '301': *462 + '301': *463 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92760,9 +93266,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: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: true content: @@ -92784,17 +93290,17 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 + default: *641 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *462 + '301': *463 '403': *27 - '410': *459 + '410': *637 '422': *15 '404': *6 x-github: @@ -92825,9 +93331,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: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -92839,15 +93345,15 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 - '301': *462 + default: *641 + '301': *463 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *459 + '410': *637 x-github: triggersNotification: true githubCloudOnly: false @@ -92873,9 +93379,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: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - *17 - *19 responses: @@ -92885,14 +93391,14 @@ paths: application/json: schema: type: array - items: *218 + items: *219 examples: - default: *642 + default: *644 headers: Link: *41 - '301': *462 + '301': *463 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92909,9 +93415,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - *17 - *19 responses: @@ -92925,7 +93431,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &645 + - &647 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -92974,7 +93480,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &646 + - &648 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -93102,7 +93608,7 @@ paths: - performed_via_github_app - assignee - assigner - - &647 + - &649 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -93148,7 +93654,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &648 + - &650 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -93194,7 +93700,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &649 + - &651 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -93243,7 +93749,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &650 + - &652 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -93272,7 +93778,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *296 + requested_team: *300 requested_reviewer: *4 required: - review_requester @@ -93285,7 +93791,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &651 + - &653 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -93314,7 +93820,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *296 + requested_team: *300 requested_reviewer: *4 required: - review_requester @@ -93327,7 +93833,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &652 + - &654 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -93383,7 +93889,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &653 + - &655 title: Locked Issue Event description: Locked Issue Event type: object @@ -93428,7 +93934,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &654 + - &656 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -93489,7 +93995,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &655 + - &657 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -93550,7 +94056,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &656 + - &658 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -93611,7 +94117,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &657 + - &659 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -93704,7 +94210,7 @@ paths: color: red headers: Link: *41 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93721,9 +94227,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - *17 - *19 responses: @@ -93733,7 +94239,7 @@ paths: application/json: schema: type: array - items: &643 + items: &645 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -93788,7 +94294,7 @@ paths: - color - default examples: - default: &644 + default: &646 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -93806,9 +94312,9 @@ paths: default: false headers: Link: *41 - '301': *462 + '301': *463 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93825,9 +94331,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: false content: @@ -93886,12 +94392,12 @@ paths: application/json: schema: type: array - items: *643 + items: *645 examples: - default: *644 - '301': *462 + default: *646 + '301': *463 '404': *6 - '410': *459 + '410': *637 '422': *15 x-github: githubCloudOnly: false @@ -93908,9 +94414,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: false content: @@ -93970,12 +94476,12 @@ paths: application/json: schema: type: array - items: *643 + items: *645 examples: - default: *644 - '301': *462 + default: *646 + '301': *463 '404': *6 - '410': *459 + '410': *637 '422': *15 x-github: githubCloudOnly: false @@ -93992,15 +94498,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 responses: '204': description: Response - '301': *462 + '301': *463 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94019,9 +94525,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - name: name in: path required: true @@ -94034,7 +94540,7 @@ paths: application/json: schema: type: array - items: *643 + items: *645 examples: default: value: @@ -94045,9 +94551,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *462 + '301': *463 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94067,9 +94573,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: false content: @@ -94098,7 +94604,7 @@ paths: '204': description: Response '403': *27 - '410': *459 + '410': *637 '404': *6 '422': *15 x-github: @@ -94116,9 +94622,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 responses: '204': description: Response @@ -94148,20 +94654,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 responses: '200': description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 - '301': *462 + default: *641 + '301': *463 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94178,9 +94684,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - 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. @@ -94206,13 +94712,13 @@ paths: application/json: schema: type: array - items: *437 + items: *440 examples: - default: *439 + default: *442 headers: Link: *41 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94230,9 +94736,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: true content: @@ -94264,16 +94770,16 @@ paths: description: Response content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '201': description: Response content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '422': *15 x-github: githubCloudOnly: false @@ -94295,10 +94801,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *448 - - *449 - - *640 - - *440 + - *451 + - *452 + - *642 + - *443 responses: '204': description: Response @@ -94327,9 +94833,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: true content: @@ -94351,9 +94857,9 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 + default: *641 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -94386,9 +94892,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - *17 - *19 responses: @@ -94398,13 +94904,13 @@ paths: application/json: schema: type: array - items: *218 + items: *219 examples: - default: *642 + default: *644 headers: Link: *41 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94432,9 +94938,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: true content: @@ -94461,16 +94967,16 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 + default: *641 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *459 + '410': *637 '422': *15 '404': *6 x-github: @@ -94490,9 +94996,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 requestBody: required: true content: @@ -94523,9 +95029,9 @@ paths: description: Response content: application/json: - schema: *218 + schema: *219 examples: - default: *639 + default: *641 '403': *27 '404': *6 '422': *7 @@ -94547,9 +95053,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *448 - - *449 - - *640 + - *451 + - *452 + - *642 - *17 - *19 responses: @@ -94564,8 +95070,6 @@ paths: description: Timeline Event type: object anyOf: - - *645 - - *646 - *647 - *648 - *649 @@ -94577,6 +95081,8 @@ paths: - *655 - *656 - *657 + - *658 + - *659 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -94624,12 +95130,12 @@ paths: issue_url: type: string format: uri - author_association: *205 + author_association: *206 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *206 + reactions: *207 required: - event - actor @@ -94660,7 +95166,7 @@ paths: properties: type: type: string - issue: *218 + issue: *219 required: - event - created_at @@ -94882,7 +95388,7 @@ paths: type: string body_text: type: string - author_association: *205 + author_association: *206 required: - event - id @@ -94905,7 +95411,7 @@ paths: type: string comments: type: array - items: &678 + items: &680 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -95010,7 +95516,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *205 + author_association: *206 _links: type: object properties: @@ -95105,7 +95611,7 @@ paths: enum: - line - file - reactions: *206 + reactions: *207 body_html: type: string examples: @@ -95143,7 +95649,7 @@ paths: type: string comments: type: array - items: *563 + items: *564 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -95418,7 +95924,7 @@ paths: headers: Link: *41 '404': *6 - '410': *459 + '410': *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95435,8 +95941,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -95446,7 +95952,7 @@ paths: application/json: schema: type: array - items: &658 + items: &660 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -95514,8 +96020,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -95551,9 +96057,9 @@ paths: description: Response content: application/json: - schema: *658 + schema: *660 examples: - default: &659 + default: &661 value: id: 1 key: ssh-rsa AAA... @@ -95587,9 +96093,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *448 - - *449 - - &660 + - *451 + - *452 + - &662 name: key_id description: The unique identifier of the key. in: path @@ -95601,9 +96107,9 @@ paths: description: Response content: application/json: - schema: *658 + schema: *660 examples: - default: *659 + default: *661 '404': *6 x-github: githubCloudOnly: false @@ -95621,9 +96127,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *448 - - *449 - - *660 + - *451 + - *452 + - *662 responses: '204': description: Response @@ -95643,8 +96149,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -95654,9 +96160,9 @@ paths: application/json: schema: type: array - items: *643 + items: *645 examples: - default: *644 + default: *646 headers: Link: *41 '404': *6 @@ -95677,8 +96183,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -95714,9 +96220,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *645 examples: - default: &661 + default: &663 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -95748,8 +96254,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *448 - - *449 + - *451 + - *452 - name: name in: path required: true @@ -95760,9 +96266,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *645 examples: - default: *661 + default: *663 '404': *6 x-github: githubCloudOnly: false @@ -95779,8 +96285,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *448 - - *449 + - *451 + - *452 - name: name in: path required: true @@ -95819,7 +96325,7 @@ paths: description: Response content: application/json: - schema: *643 + schema: *645 examples: default: value: @@ -95845,8 +96351,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *448 - - *449 + - *451 + - *452 - name: name in: path required: true @@ -95872,8 +96378,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -95909,8 +96415,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '202': *37 '403': @@ -95938,8 +96444,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -95965,9 +96471,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *448 - - *449 - - *541 + - *451 + - *452 + - *542 responses: '200': description: Response @@ -96033,7 +96539,7 @@ paths: license: anyOf: - type: 'null' - - *219 + - *220 required: - _links - git_url @@ -96114,8 +96620,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -96180,8 +96686,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -96215,9 +96721,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *564 + schema: *565 examples: - default: *662 + default: *664 '204': description: Response when already merged '404': @@ -96242,8 +96748,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *448 - - *449 + - *451 + - *452 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -96284,7 +96790,7 @@ paths: application/json: schema: type: array - items: *387 + items: *390 examples: default: value: @@ -96340,8 +96846,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -96381,9 +96887,9 @@ paths: description: Response content: application/json: - schema: *387 + schema: *390 examples: - default: &663 + default: &665 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -96442,9 +96948,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *448 - - *449 - - &664 + - *451 + - *452 + - &666 name: milestone_number description: The number that identifies the milestone. in: path @@ -96456,9 +96962,9 @@ paths: description: Response content: application/json: - schema: *387 + schema: *390 examples: - default: *663 + default: *665 '404': *6 x-github: githubCloudOnly: false @@ -96475,9 +96981,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *448 - - *449 - - *664 + - *451 + - *452 + - *666 requestBody: required: false content: @@ -96515,9 +97021,9 @@ paths: description: Response content: application/json: - schema: *387 + schema: *390 examples: - default: *663 + default: *665 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96533,9 +97039,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *448 - - *449 - - *664 + - *451 + - *452 + - *666 responses: '204': description: Response @@ -96556,9 +97062,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: - - *448 - - *449 - - *664 + - *451 + - *452 + - *666 - *17 - *19 responses: @@ -96568,9 +97074,9 @@ paths: application/json: schema: type: array - items: *643 + items: *645 examples: - default: *644 + default: *646 headers: Link: *41 x-github: @@ -96589,12 +97095,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: - - *448 - - *449 - - *665 - - *666 - - *208 + - *451 + - *452 - *667 + - *668 + - *209 + - *669 - *17 - *19 responses: @@ -96604,9 +97110,9 @@ paths: application/json: schema: type: array - items: *230 + items: *231 examples: - default: *668 + default: *670 headers: Link: *41 x-github: @@ -96630,8 +97136,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: false content: @@ -96689,14 +97195,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: &669 + schema: &671 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -96840,7 +97346,7 @@ paths: - custom_404 - public examples: - default: &670 + default: &672 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -96881,8 +97387,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -96937,9 +97443,9 @@ paths: description: Response content: application/json: - schema: *669 + schema: *671 examples: - default: *670 + default: *672 '422': *15 '409': *112 x-github: @@ -96962,8 +97468,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -97071,8 +97577,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -97098,8 +97604,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -97109,7 +97615,7 @@ paths: application/json: schema: type: array - items: &671 + items: &673 title: Page Build description: Page Build type: object @@ -97201,8 +97707,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *448 - - *449 + - *451 + - *452 responses: '201': description: Response @@ -97249,16 +97755,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *671 + schema: *673 examples: - default: &672 + default: &674 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -97306,8 +97812,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *448 - - *449 + - *451 + - *452 - name: build_id in: path required: true @@ -97318,9 +97824,9 @@ paths: description: Response content: application/json: - schema: *671 + schema: *673 examples: - default: *672 + default: *674 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97340,8 +97846,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -97449,9 +97955,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: - - *448 - - *449 - - &673 + - *451 + - *452 + - &675 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -97509,9 +98015,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *448 - - *449 - - *673 + - *451 + - *452 + - *675 responses: '204': *144 '404': *6 @@ -97538,8 +98044,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -97807,7 +98313,7 @@ paths: description: Empty response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -97834,8 +98340,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Private vulnerability reporting status @@ -97872,8 +98378,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': *144 '422': *14 @@ -97894,8 +98400,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': *144 '422': *14 @@ -97904,148 +98410,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repos/{owner}/{repo}/projects": - get: - summary: List repository 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: - - projects-classic - operationId: projects-classic/list-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-repository-projects - parameters: - - *448 - - *449 - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *382 - examples: - default: - value: - - owner_url: https://api.github.com/repos/api-playground/projects-test - url: https://api.github.com/projects/1002604 - html_url: https://github.com/api-playground/projects-test/projects/1 - columns_url: https://api.github.com/projects/1002604/columns - id: 1002604 - node_id: MDc6UHJvamVjdDEwMDI2MDQ= - name: Projects Documentation - body: Developer documentation project for the developer site. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - headers: - Link: *41 - '401': *23 - '403': *27 - '404': *6 - '410': *459 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create a repository 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: - - projects-classic - operationId: projects-classic/create-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-a-repository-project - parameters: - - *448 - - *449 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the project. - body: - type: string - description: The description of the project. - required: - - name - examples: - default: - value: - name: Projects Documentation - body: Developer documentation project for the developer site. - responses: - '201': - description: Response - content: - application/json: - schema: *382 - examples: - default: *458 - '401': *23 - '403': *27 - '404': *6 - '410': *459 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/repos/{owner}/{repo}/properties/values": get: summary: Get all custom property values for a repository @@ -98059,8 +98423,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -98070,7 +98434,7 @@ paths: type: array items: *145 examples: - default: *674 + default: *676 '403': *27 '404': *6 x-github: @@ -98092,8 +98456,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -98109,7 +98473,7 @@ paths: required: - properties examples: - default: *675 + default: *677 responses: '204': description: No Content when custom property values are successfully created @@ -98147,8 +98511,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *448 - - *449 + - *451 + - *452 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -98208,9 +98572,9 @@ paths: application/json: schema: type: array - items: *568 + items: *569 examples: - default: *676 + default: *678 headers: Link: *41 '304': *35 @@ -98242,8 +98606,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -98310,7 +98674,7 @@ paths: description: Response content: application/json: - schema: &680 + schema: &682 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -98439,7 +98803,7 @@ paths: milestone: anyOf: - type: 'null' - - *387 + - *390 active_lock_reason: type: - string @@ -98494,7 +98858,7 @@ paths: type: - array - 'null' - items: *364 + items: *368 head: type: object properties: @@ -98532,14 +98896,14 @@ paths: _links: type: object properties: - comments: *388 - commits: *388 - statuses: *388 - html: *388 - issue: *388 - review_comments: *388 - review_comment: *388 - self: *388 + comments: *391 + commits: *391 + statuses: *391 + html: *391 + issue: *391 + review_comments: *391 + review_comment: *391 + self: *391 required: - comments - commits @@ -98549,8 +98913,8 @@ paths: - review_comments - review_comment - self - author_association: *205 - auto_merge: *677 + author_association: *206 + auto_merge: *679 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -98652,7 +99016,7 @@ paths: - merged_by - review_comments examples: - default: &681 + default: &683 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -99179,8 +99543,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *448 - - *449 + - *451 + - *452 - name: sort in: query required: false @@ -99199,7 +99563,7 @@ paths: enum: - asc - desc - - *208 + - *209 - *17 - *19 responses: @@ -99209,9 +99573,9 @@ paths: application/json: schema: type: array - items: *678 + items: *680 examples: - default: &683 + default: &685 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -99288,17 +99652,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: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 responses: '200': description: Response content: application/json: - schema: *678 + schema: *680 examples: - default: &679 + default: &681 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -99373,9 +99737,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: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 requestBody: required: true content: @@ -99397,9 +99761,9 @@ paths: description: Response content: application/json: - schema: *678 + schema: *680 examples: - default: *679 + default: *681 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99415,9 +99779,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: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 responses: '204': description: Response @@ -99438,9 +99802,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: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 - 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. @@ -99466,9 +99830,9 @@ paths: application/json: schema: type: array - items: *437 + items: *440 examples: - default: *439 + default: *442 headers: Link: *41 '404': *6 @@ -99489,9 +99853,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: - - *448 - - *449 - - *217 + - *451 + - *452 + - *218 requestBody: required: true content: @@ -99523,16 +99887,16 @@ paths: description: Reaction exists content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '201': description: Reaction created content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '422': *15 x-github: githubCloudOnly: false @@ -99554,10 +99918,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *448 - - *449 - - *217 - - *440 + - *451 + - *452 + - *218 + - *443 responses: '204': description: Response @@ -99600,9 +99964,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *448 - - *449 - - &682 + - *451 + - *452 + - &684 name: pull_number description: The number that identifies the pull request. in: path @@ -99615,9 +99979,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *680 + schema: *682 examples: - default: *681 + default: *683 '304': *35 '404': *6 '406': @@ -99652,9 +100016,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 requestBody: required: false content: @@ -99696,9 +100060,9 @@ paths: description: Response content: application/json: - schema: *680 + schema: *682 examples: - default: *681 + default: *683 '422': *15 '403': *27 x-github: @@ -99720,9 +100084,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: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 requestBody: required: true content: @@ -99783,17 +100147,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '401': *23 '403': *27 '404': *6 @@ -99823,10 +100187,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: - - *448 - - *449 - - *682 - - *227 + - *451 + - *452 + - *684 + - *228 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -99836,7 +100200,7 @@ paths: enum: - asc - desc - - *208 + - *209 - *17 - *19 responses: @@ -99846,9 +100210,9 @@ paths: application/json: schema: type: array - items: *678 + items: *680 examples: - default: *683 + default: *685 headers: Link: *41 x-github: @@ -99881,9 +100245,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: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 requestBody: required: true content: @@ -99989,7 +100353,7 @@ paths: description: Response content: application/json: - schema: *678 + schema: *680 examples: example-for-a-multi-line-comment: value: @@ -100077,10 +100441,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: - - *448 - - *449 - - *682 - - *217 + - *451 + - *452 + - *684 + - *218 requestBody: required: true content: @@ -100102,7 +100466,7 @@ paths: description: Response content: application/json: - schema: *678 + schema: *680 examples: default: value: @@ -100188,9 +100552,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 - *17 - *19 responses: @@ -100200,9 +100564,9 @@ paths: application/json: schema: type: array - items: *564 + items: *565 examples: - default: *684 + default: *686 headers: Link: *41 x-github: @@ -100232,9 +100596,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 - *17 - *19 responses: @@ -100244,7 +100608,7 @@ paths: application/json: schema: type: array - items: *575 + items: *576 examples: default: value: @@ -100282,9 +100646,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: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 responses: '204': description: Response if pull request has been merged @@ -100307,9 +100671,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 requestBody: required: false content: @@ -100421,9 +100785,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: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 responses: '200': description: Response @@ -100439,7 +100803,7 @@ paths: items: *4 teams: type: array - items: *296 + items: *300 required: - users - teams @@ -100498,9 +100862,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: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 requestBody: required: false content: @@ -100537,7 +100901,7 @@ paths: description: Response content: application/json: - schema: *568 + schema: *569 examples: default: value: @@ -101073,9 +101437,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: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 requestBody: required: true content: @@ -101109,7 +101473,7 @@ paths: description: Response content: application/json: - schema: *568 + schema: *569 examples: default: value: @@ -101614,9 +101978,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 - *17 - *19 responses: @@ -101626,7 +101990,7 @@ paths: application/json: schema: type: array - items: &685 + items: &687 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -101700,7 +102064,7 @@ paths: type: string body_text: type: string - author_association: *205 + author_association: *206 required: - id - node_id @@ -101782,9 +102146,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: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 requestBody: required: false content: @@ -101874,9 +102238,9 @@ paths: description: Response content: application/json: - schema: *685 + schema: *687 examples: - default: &687 + default: &689 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -101939,10 +102303,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: - - *448 - - *449 - - *682 - - &686 + - *451 + - *452 + - *684 + - &688 name: review_id description: The unique identifier of the review. in: path @@ -101954,9 +102318,9 @@ paths: description: Response content: application/json: - schema: *685 + schema: *687 examples: - default: &688 + default: &690 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -102015,10 +102379,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: - - *448 - - *449 - - *682 - - *686 + - *451 + - *452 + - *684 + - *688 requestBody: required: true content: @@ -102041,7 +102405,7 @@ paths: description: Response content: application/json: - schema: *685 + schema: *687 examples: default: value: @@ -102103,18 +102467,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: - - *448 - - *449 - - *682 - - *686 + - *451 + - *452 + - *684 + - *688 responses: '200': description: Response content: application/json: - schema: *685 + schema: *687 examples: - default: *687 + default: *689 '422': *7 '404': *6 x-github: @@ -102141,10 +102505,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: - - *448 - - *449 - - *682 - - *686 + - *451 + - *452 + - *684 + - *688 - *17 - *19 responses: @@ -102238,13 +102602,13 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *205 + author_association: *206 _links: type: object properties: - self: *388 - html: *388 - pull_request: *388 + self: *391 + html: *391 + pull_request: *391 required: - self - html @@ -102253,7 +102617,7 @@ paths: type: string body_html: type: string - reactions: *206 + reactions: *207 side: description: The side of the first line of the range for a multi-line comment. @@ -102402,10 +102766,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: - - *448 - - *449 - - *682 - - *686 + - *451 + - *452 + - *684 + - *688 requestBody: required: true content: @@ -102434,7 +102798,7 @@ paths: description: Response content: application/json: - schema: *685 + schema: *687 examples: default: value: @@ -102497,10 +102861,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: - - *448 - - *449 - - *682 - - *686 + - *451 + - *452 + - *684 + - *688 requestBody: required: true content: @@ -102535,9 +102899,9 @@ paths: description: Response content: application/json: - schema: *685 + schema: *687 examples: - default: *688 + default: *690 '404': *6 '422': *7 '403': *27 @@ -102559,9 +102923,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *448 - - *449 - - *682 + - *451 + - *452 + - *684 requestBody: required: false content: @@ -102625,8 +102989,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *448 - - *449 + - *451 + - *452 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -102639,9 +103003,9 @@ paths: description: Response content: application/json: - schema: *689 + schema: *691 examples: - default: &690 + default: &692 value: type: file encoding: base64 @@ -102683,8 +103047,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: - - *448 - - *449 + - *451 + - *452 - name: dir description: The alternate path to look for a README file in: path @@ -102704,9 +103068,9 @@ paths: description: Response content: application/json: - schema: *689 + schema: *691 examples: - default: *690 + default: *692 '404': *6 '422': *15 x-github: @@ -102728,8 +103092,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -102739,7 +103103,7 @@ paths: application/json: schema: type: array - items: &691 + items: &693 title: Release description: A release. type: object @@ -102821,7 +103185,7 @@ paths: author: *4 assets: type: array - items: &692 + items: &694 title: Release Asset description: Data related to a release. type: object @@ -102896,7 +103260,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *206 + reactions: *207 required: - assets_url - upload_url @@ -103008,8 +103372,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -103085,9 +103449,9 @@ paths: description: Response content: application/json: - schema: *691 + schema: *693 examples: - default: &695 + default: &697 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -103192,9 +103556,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *448 - - *449 - - &693 + - *451 + - *452 + - &695 name: asset_id description: The unique identifier of the asset. in: path @@ -103206,9 +103570,9 @@ paths: description: Response content: application/json: - schema: *692 + schema: *694 examples: - default: &694 + default: &696 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 @@ -103243,7 +103607,7 @@ paths: type: User site_admin: false '404': *6 - '302': *577 + '302': *578 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103259,9 +103623,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *448 - - *449 - - *693 + - *451 + - *452 + - *695 requestBody: required: false content: @@ -103290,9 +103654,9 @@ paths: description: Response content: application/json: - schema: *692 + schema: *694 examples: - default: *694 + default: *696 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103308,9 +103672,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *448 - - *449 - - *693 + - *451 + - *452 + - *695 responses: '204': description: Response @@ -103334,8 +103698,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -103421,16 +103785,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response content: application/json: - schema: *691 + schema: *693 examples: - default: *695 + default: *697 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103447,8 +103811,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *448 - - *449 + - *451 + - *452 - name: tag description: tag parameter in: path @@ -103461,9 +103825,9 @@ paths: description: Response content: application/json: - schema: *691 + schema: *693 examples: - default: *695 + default: *697 '404': *6 x-github: githubCloudOnly: false @@ -103485,9 +103849,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *448 - - *449 - - &696 + - *451 + - *452 + - &698 name: release_id description: The unique identifier of the release. in: path @@ -103501,9 +103865,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: *691 + schema: *693 examples: - default: *695 + default: *697 '401': description: Unauthorized x-github: @@ -103521,9 +103885,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *448 - - *449 - - *696 + - *451 + - *452 + - *698 requestBody: required: false content: @@ -103587,9 +103951,9 @@ paths: description: Response content: application/json: - schema: *691 + schema: *693 examples: - default: *695 + default: *697 '404': description: Not Found if the discussion category name is invalid content: @@ -103610,9 +103974,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *448 - - *449 - - *696 + - *451 + - *452 + - *698 responses: '204': description: Response @@ -103632,9 +103996,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *448 - - *449 - - *696 + - *451 + - *452 + - *698 - *17 - *19 responses: @@ -103644,7 +104008,7 @@ paths: application/json: schema: type: array - items: *692 + items: *694 examples: default: value: @@ -103726,9 +104090,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: - - *448 - - *449 - - *696 + - *451 + - *452 + - *698 - name: name in: query required: true @@ -103754,7 +104118,7 @@ paths: description: Response for successful upload content: application/json: - schema: *692 + schema: *694 examples: response-for-successful-upload: value: @@ -103809,9 +104173,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *448 - - *449 - - *696 + - *451 + - *452 + - *698 - 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. @@ -103835,9 +104199,9 @@ paths: application/json: schema: type: array - items: *437 + items: *440 examples: - default: *439 + default: *442 headers: Link: *41 '404': *6 @@ -103858,9 +104222,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *448 - - *449 - - *696 + - *451 + - *452 + - *698 requestBody: required: true content: @@ -103890,16 +104254,16 @@ paths: description: Reaction exists content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '201': description: Reaction created content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 '422': *15 x-github: githubCloudOnly: false @@ -103921,10 +104285,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *448 - - *449 - - *696 - - *440 + - *451 + - *452 + - *698 + - *443 responses: '204': description: Response @@ -103948,9 +104312,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *448 - - *449 - - *507 + - *451 + - *452 + - *508 - *17 - *19 responses: @@ -103967,7 +104331,7 @@ paths: oneOf: - allOf: - *159 - - &697 + - &699 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -103988,67 +104352,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *160 - - *697 + - *699 - allOf: - *161 - - *697 + - *699 - allOf: - *162 - - *697 + - *699 - allOf: - - *698 - - *697 + - *700 + - *699 - allOf: - *163 - - *697 + - *699 - allOf: - *164 - - *697 + - *699 - allOf: - *165 - - *697 + - *699 - allOf: - *166 - - *697 + - *699 - allOf: - *167 - - *697 + - *699 - allOf: - *168 - - *697 + - *699 - allOf: - *169 - - *697 + - *699 - allOf: - *170 - - *697 + - *699 - allOf: - *171 - - *697 + - *699 - allOf: - *172 - - *697 + - *699 - allOf: - *173 - - *697 + - *699 - allOf: - *174 - - *697 + - *699 - allOf: - *175 - - *697 + - *699 - allOf: - *176 - - *697 + - *699 - allOf: - *177 - - *697 + - *699 - allOf: - *178 - - *697 + - *699 - allOf: + - *701 - *699 - - *697 examples: default: value: @@ -104087,8 +104451,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 - name: includes_parents @@ -104099,7 +104463,7 @@ paths: schema: type: boolean default: true - - *700 + - *702 responses: '200': description: Response @@ -104154,8 +104518,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *451 + - *452 requestBody: description: Request body required: true @@ -104184,7 +104548,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *701 + items: *703 required: - name - enforcement @@ -104217,7 +104581,7 @@ paths: application/json: schema: *179 examples: - default: &710 + default: &712 value: id: 42 name: super cool ruleset @@ -104264,12 +104628,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *448 - - *449 - - *702 - - *99 - - *703 + - *451 + - *452 - *704 + - *99 + - *705 + - *706 - *17 - *19 responses: @@ -104277,9 +104641,9 @@ paths: description: Response content: application/json: - schema: *705 + schema: *707 examples: - default: *706 + default: *708 '404': *6 '500': *38 x-github: @@ -104300,17 +104664,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *448 - - *449 - - *707 + - *451 + - *452 + - *709 responses: '200': description: Response content: application/json: - schema: *708 + schema: *710 examples: - default: *709 + default: *711 '404': *6 '500': *38 x-github: @@ -104338,8 +104702,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *451 + - *452 - name: ruleset_id description: The ID of the ruleset. in: path @@ -104361,7 +104725,7 @@ paths: application/json: schema: *179 examples: - default: *710 + default: *712 '404': *6 '500': *38 put: @@ -104379,8 +104743,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *451 + - *452 - name: ruleset_id description: The ID of the ruleset. in: path @@ -104414,7 +104778,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *701 + items: *703 examples: default: value: @@ -104444,7 +104808,7 @@ paths: application/json: schema: *179 examples: - default: *710 + default: *712 '404': *6 '500': *38 delete: @@ -104462,8 +104826,8 @@ paths: category: repos subcategory: rules parameters: - - *448 - - *449 + - *451 + - *452 - name: ruleset_id description: The ID of the ruleset. in: path @@ -104486,8 +104850,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 - name: ruleset_id @@ -104505,7 +104869,7 @@ paths: type: array items: *183 examples: - default: *401 + default: *404 '404': *6 '500': *38 x-github: @@ -104524,8 +104888,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *448 - - *449 + - *451 + - *452 - name: ruleset_id description: The ID of the ruleset. in: path @@ -104543,7 +104907,7 @@ paths: description: Response content: application/json: - schema: *402 + schema: *405 examples: default: value: @@ -104598,21 +104962,21 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *448 - - *449 - - *403 - - *404 - - *405 + - *451 + - *452 - *406 - - *104 - - *19 - - *17 - - *711 - - *712 - *407 - *408 - *409 + - *104 + - *19 + - *17 + - *713 + - *714 - *410 + - *411 + - *412 + - *413 responses: '200': description: Response @@ -104620,7 +104984,7 @@ paths: application/json: schema: type: array - items: &716 + items: &718 type: object properties: number: *119 @@ -104636,8 +105000,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *713 - resolution: *714 + state: *715 + resolution: *716 resolved_at: type: - string @@ -104731,7 +105095,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *715 + - *717 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -104876,16 +105240,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: - - *448 - - *449 - - *535 - - *410 + - *451 + - *452 + - *536 + - *413 responses: '200': description: Response content: application/json: - schema: *716 + schema: *718 examples: default: value: @@ -104937,9 +105301,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: - - *448 - - *449 - - *535 + - *451 + - *452 + - *536 requestBody: required: true content: @@ -104947,16 +105311,17 @@ paths: schema: type: object properties: - state: *713 - resolution: *714 + state: *715 + resolution: *716 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: - string - 'null' - required: - - state + anyOf: + - required: + - state examples: default: value: @@ -104967,7 +105332,7 @@ paths: description: Response content: application/json: - schema: *716 + schema: *718 examples: default: value: @@ -105042,9 +105407,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: - - *448 - - *449 - - *535 + - *451 + - *452 + - *536 - *19 - *17 responses: @@ -105055,7 +105420,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &892 + items: &894 type: object properties: type: @@ -105082,8 +105447,6 @@ paths: - commit details: oneOf: - - *717 - - *718 - *719 - *720 - *721 @@ -105095,6 +105458,8 @@ paths: - *727 - *728 - *729 + - *730 + - *731 examples: default: value: @@ -105180,8 +105545,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -105189,14 +105554,14 @@ paths: schema: type: object properties: - reason: &731 + reason: &733 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *730 + placeholder_id: *732 required: - reason - placeholder_id @@ -105213,7 +105578,7 @@ paths: schema: type: object properties: - reason: *731 + reason: *733 expire_at: type: - string @@ -105260,8 +105625,8 @@ 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: - - *448 - - *449 + - *451 + - *452 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -105276,7 +105641,7 @@ paths: properties: incremental_scans: type: array - items: &732 + items: &734 description: Information on a single scan performed by secret scanning on the repository type: object @@ -105304,15 +105669,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *732 + items: *734 backfill_scans: type: array - items: *732 + items: *734 custom_pattern_backfill_scans: type: array items: allOf: - - *732 + - *734 - type: object properties: pattern_name: @@ -105382,8 +105747,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *448 - - *449 + - *451 + - *452 - *104 - name: sort description: The property to sort the results by. @@ -105427,9 +105792,9 @@ paths: application/json: schema: type: array - items: *733 + items: *735 examples: - default: *734 + default: *736 '400': *14 '404': *6 x-github: @@ -105452,8 +105817,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -105533,7 +105898,7 @@ paths: login: type: string description: The username of the user credited. - type: *415 + type: *418 required: - login - type @@ -105623,9 +105988,9 @@ paths: description: Response content: application/json: - schema: *733 + schema: *735 examples: - default: &736 + default: &738 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -105858,8 +106223,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -105972,7 +106337,7 @@ paths: description: Response content: application/json: - schema: *733 + schema: *735 examples: default: value: @@ -106119,17 +106484,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: - - *448 - - *449 - - *735 + - *451 + - *452 + - *737 responses: '200': description: Response content: application/json: - schema: *733 + schema: *735 examples: - default: *736 + default: *738 '403': *27 '404': *6 x-github: @@ -106153,9 +106518,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: - - *448 - - *449 - - *735 + - *451 + - *452 + - *737 requestBody: required: true content: @@ -106235,7 +106600,7 @@ paths: login: type: string description: The username of the user credited. - type: *415 + type: *418 required: - login - type @@ -106326,17 +106691,17 @@ paths: description: Response content: application/json: - schema: *733 + schema: *735 examples: - default: *736 - add_credit: *736 + default: *738 + add_credit: *738 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *244 + schema: *248 examples: invalid_state_transition: value: @@ -106367,9 +106732,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: - - *448 - - *449 - - *735 + - *451 + - *452 + - *737 responses: '202': *37 '400': *14 @@ -106396,17 +106761,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *448 - - *449 - - *735 + - *451 + - *452 + - *737 responses: '202': description: Response content: application/json: - schema: *461 + schema: *462 examples: - default: *463 + default: *464 '400': *14 '422': *15 '403': *27 @@ -106432,8 +106797,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -106529,8 +106894,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -106539,7 +106904,7 @@ paths: application/json: schema: type: array - items: &737 + items: &739 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -106572,8 +106937,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -106651,8 +107016,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -106746,8 +107111,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -106901,8 +107266,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -106912,7 +107277,7 @@ paths: application/json: schema: type: array - items: *737 + items: *739 examples: default: value: @@ -106945,8 +107310,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *448 - - *449 + - *451 + - *452 - name: sha in: path required: true @@ -107002,7 +107367,7 @@ paths: description: Response content: application/json: - schema: *738 + schema: *740 examples: default: value: @@ -107056,8 +107421,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -107069,7 +107434,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 x-github: @@ -107089,14 +107454,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &739 + schema: &741 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -107169,8 +107534,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: false content: @@ -107196,7 +107561,7 @@ paths: description: Response content: application/json: - schema: *739 + schema: *741 examples: default: value: @@ -107223,8 +107588,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -107244,8 +107609,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -107327,8 +107692,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: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -107336,7 +107701,7 @@ paths: application/json: schema: type: array - items: &740 + items: &742 title: Tag protection description: Tag protection type: object @@ -107393,8 +107758,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: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -107417,7 +107782,7 @@ paths: description: Response content: application/json: - schema: *740 + schema: *742 examples: default: value: @@ -107448,8 +107813,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: - - *448 - - *449 + - *451 + - *452 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -107486,8 +107851,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *448 - - *449 + - *451 + - *452 - name: ref in: path required: true @@ -107523,8 +107888,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *448 - - *449 + - *451 + - *452 - *17 - *19 responses: @@ -107534,9 +107899,9 @@ paths: application/json: schema: type: array - items: *296 + items: *300 examples: - default: *365 + default: *369 headers: Link: *41 '404': *6 @@ -107556,8 +107921,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *448 - - *449 + - *451 + - *452 - *19 - *17 responses: @@ -107565,7 +107930,7 @@ paths: description: Response content: application/json: - schema: &741 + schema: &743 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -107577,7 +107942,7 @@ paths: required: - names examples: - default: &742 + default: &744 value: names: - octocat @@ -107600,8 +107965,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -107632,9 +107997,9 @@ paths: description: Response content: application/json: - schema: *741 + schema: *743 examples: - default: *742 + default: *744 '404': *6 '422': *7 x-github: @@ -107655,9 +108020,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *448 - - *449 - - &743 + - *451 + - *452 + - &745 name: per description: The time frame to display results for. in: query @@ -107688,7 +108053,7 @@ paths: - 128 clones: type: array - items: &744 + items: &746 title: Traffic type: object properties: @@ -107775,8 +108140,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -107870,8 +108235,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *448 - - *449 + - *451 + - *452 responses: '200': description: Response @@ -107934,9 +108299,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *448 - - *449 - - *743 + - *451 + - *452 + - *745 responses: '200': description: Response @@ -107957,7 +108322,7 @@ paths: - 3782 views: type: array - items: *744 + items: *746 required: - uniques - count @@ -108034,8 +108399,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *448 - - *449 + - *451 + - *452 requestBody: required: true content: @@ -108071,7 +108436,7 @@ paths: description: Response content: application/json: - schema: *269 + schema: *273 examples: default: value: @@ -108309,8 +108674,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: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -108333,8 +108698,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -108356,8 +108721,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -108383,8 +108748,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *448 - - *449 + - *451 + - *452 - name: ref in: path required: true @@ -108476,9 +108841,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *462 examples: - default: *463 + default: *464 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -108519,7 +108884,7 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: default: value: @@ -108629,7 +108994,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &752 + - &754 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -108639,7 +109004,7 @@ paths: type: string examples: - members - - &757 + - &759 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -108651,7 +109016,7 @@ paths: format: int32 examples: - 1 - - &758 + - &760 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -108695,7 +109060,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &747 + items: &749 allOf: - type: object required: @@ -108777,7 +109142,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: &759 + meta: &761 type: object description: The metadata associated with the creation/updates to the user. @@ -108842,30 +109207,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &748 + '400': &750 description: Bad request content: application/json: - schema: *745 + schema: *747 application/scim+json: - schema: *745 - '401': *746 - '403': &749 + schema: *747 + '401': *748 + '403': &751 description: Permission denied - '429': &750 + '429': &752 description: Too many requests content: application/json: - schema: *745 + schema: *747 application/scim+json: - schema: *745 - '500': &751 + schema: *747 + '500': &753 description: Internal server error content: application/json: - schema: *745 + schema: *747 application/scim+json: - schema: *745 + schema: *747 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -108889,7 +109254,7 @@ paths: required: true content: application/json: - schema: &755 + schema: &757 type: object required: - schemas @@ -108953,9 +109318,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *747 + schema: *749 examples: - group: &753 + group: &755 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -108974,13 +109339,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': *748 - '401': *746 - '403': *749 - '409': &756 + '400': *750 + '401': *748 + '403': *751 + '409': &758 description: Duplicate record detected - '429': *750 - '500': *751 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -108997,7 +109362,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: - - &754 + - &756 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -109006,22 +109371,22 @@ paths: type: string examples: - 7fce0092-d52e-4f76-b727-3955bd72c939 - - *752 + - *754 - *39 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *747 + schema: *749 examples: - default: *753 - '400': *748 - '401': *746 - '403': *749 + default: *755 + '400': *750 + '401': *748 + '403': *751 '404': *6 - '429': *750 - '500': *751 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109040,13 +109405,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: - - *754 + - *756 - *39 requestBody: required: true content: application/json: - schema: *755 + schema: *757 examples: group: summary: Group @@ -109072,17 +109437,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *747 + schema: *749 examples: - group: *753 - groupWithMembers: *753 - '400': *748 - '401': *746 - '403': *749 + group: *755 + groupWithMembers: *755 + '400': *750 + '401': *748 + '403': *751 '404': *6 - '409': *756 - '429': *750 - '500': *751 + '409': *758 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109106,13 +109471,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: - - *754 + - *756 - *39 requestBody: required: true content: application/json: - schema: &766 + schema: &768 type: object required: - Operations @@ -109172,17 +109537,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *747 + schema: *749 examples: - updateGroup: *753 - addMembers: *753 - '400': *748 - '401': *746 - '403': *749 + updateGroup: *755 + addMembers: *755 + '400': *750 + '401': *748 + '403': *751 '404': *6 - '409': *756 - '429': *750 - '500': *751 + '409': *758 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109198,17 +109563,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: - - *754 + - *756 - *39 responses: '204': description: Group was deleted, no content - '400': *748 - '401': *746 - '403': *749 + '400': *750 + '401': *748 + '403': *751 '404': *6 - '429': *750 - '500': *751 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109242,8 +109607,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *757 - - *758 + - *759 + - *760 - *39 responses: '200': @@ -109277,7 +109642,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &761 + items: &763 allOf: - type: object required: @@ -109369,7 +109734,7 @@ paths: address. examples: - true - roles: &760 + roles: &762 type: array description: The roles assigned to the user. items: @@ -109428,7 +109793,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *759 + meta: *761 startIndex: type: integer description: A starting index for the returned page @@ -109467,11 +109832,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *748 - '401': *746 - '403': *749 - '429': *750 - '500': *751 + '400': *750 + '401': *748 + '403': *751 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109495,7 +109860,7 @@ paths: required: true content: application/json: - schema: &764 + schema: &766 type: object required: - schemas @@ -109588,9 +109953,9 @@ paths: description: Whether this email address is the primary address. examples: - true - roles: *760 + roles: *762 examples: - user: &765 + user: &767 summary: User value: schemas: @@ -109637,9 +110002,9 @@ paths: description: User has been created content: application/scim+json: - schema: *761 + schema: *763 examples: - user: &762 + user: &764 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -109665,13 +110030,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: *762 - '400': *748 - '401': *746 - '403': *749 - '409': *756 - '429': *750 - '500': *751 + enterpriseOwner: *764 + '400': *750 + '401': *748 + '403': *751 + '409': *758 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109688,7 +110053,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: - - &763 + - &765 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -109701,15 +110066,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *761 + schema: *763 examples: - default: *762 - '400': *748 - '401': *746 - '403': *749 + default: *764 + '400': *750 + '401': *748 + '403': *751 '404': *6 - '429': *750 - '500': *751 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109731,30 +110096,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: - - *763 + - *765 - *39 requestBody: required: true content: application/json: - schema: *764 + schema: *766 examples: - user: *765 + user: *767 responses: '200': description: User was updated content: application/scim+json: - schema: *761 + schema: *763 examples: - user: *762 - '400': *748 - '401': *746 - '403': *749 + user: *764 + '400': *750 + '401': *748 + '403': *751 '404': *6 - '409': *756 - '429': *750 - '500': *751 + '409': *758 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109789,13 +110154,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: - - *763 + - *765 - *39 requestBody: required: true content: application/json: - schema: *766 + schema: *768 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -109835,18 +110200,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *761 + schema: *763 examples: - userMultiValuedProperties: *762 - userSingleValuedProperties: *762 - disableUser: *762 - '400': *748 - '401': *746 - '403': *749 + userMultiValuedProperties: *764 + userSingleValuedProperties: *764 + disableUser: *764 + '400': *750 + '401': *748 + '403': *751 '404': *6 - '409': *756 - '429': *750 - '500': *751 + '409': *758 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109866,17 +110231,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: - - *763 + - *765 - *39 responses: '204': description: User was deleted, no content - '400': *748 - '401': *746 - '403': *749 + '400': *750 + '401': *748 + '403': *751 '404': *6 - '429': *750 - '500': *751 + '429': *752 + '500': *753 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -109967,7 +110332,7 @@ paths: - 1 Resources: type: array - items: &767 + items: &769 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -110214,22 +110579,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *35 - '404': &768 + '404': &770 description: Resource not found content: application/json: - schema: *745 + schema: *747 application/scim+json: - schema: *745 - '403': &769 + schema: *747 + '403': &771 description: Forbidden content: application/json: - schema: *745 + schema: *747 application/scim+json: - schema: *745 - '400': *748 - '429': *750 + schema: *747 + '400': *750 + '429': *752 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -110255,9 +110620,9 @@ paths: description: Response content: application/scim+json: - schema: *767 + schema: *769 examples: - default: &770 + default: &772 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -110280,17 +110645,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *35 - '404': *768 - '403': *769 - '500': *751 + '404': *770 + '403': *771 + '500': *753 '409': description: Conflict content: application/json: - schema: *745 + schema: *747 application/scim+json: - schema: *745 - '400': *748 + schema: *747 + '400': *750 requestBody: required: true content: @@ -110390,17 +110755,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *81 - - *763 + - *765 responses: '200': description: Response content: application/scim+json: - schema: *767 + schema: *769 examples: - default: *770 - '404': *768 - '403': *769 + default: *772 + '404': *770 + '403': *771 '304': *35 x-github: githubCloudOnly: true @@ -110424,18 +110789,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - *81 - - *763 + - *765 responses: '200': description: Response content: application/scim+json: - schema: *767 + schema: *769 examples: - default: *770 + default: *772 '304': *35 - '404': *768 - '403': *769 + '404': *770 + '403': *771 requestBody: required: true content: @@ -110550,19 +110915,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *81 - - *763 + - *765 responses: '200': description: Response content: application/scim+json: - schema: *767 + schema: *769 examples: - default: *770 + default: *772 '304': *35 - '404': *768 - '403': *769 - '400': *748 + '404': *770 + '403': *771 + '400': *750 '429': description: Response content: @@ -110658,12 +111023,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *81 - - *763 + - *765 responses: '204': description: Response - '404': *768 - '403': *769 + '404': *770 + '403': *771 '304': *35 x-github: githubCloudOnly: true @@ -110778,7 +111143,7 @@ paths: html_url: type: string format: uri - repository: *269 + repository: *273 score: type: number file_size: @@ -110797,7 +111162,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &771 + text_matches: &773 title: Search Result Text Matches type: array items: @@ -110961,7 +111326,7 @@ paths: enum: - author-date - committer-date - - &772 + - &774 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 @@ -111030,7 +111395,7 @@ paths: committer: anyOf: - type: 'null' - - *505 + - *506 comment_count: type: integer message: @@ -111049,7 +111414,7 @@ paths: url: type: string format: uri - verification: *622 + verification: *623 required: - author - committer @@ -111064,7 +111429,7 @@ paths: committer: anyOf: - type: 'null' - - *505 + - *506 parents: type: array items: @@ -111076,12 +111441,12 @@ paths: type: string sha: type: string - repository: *269 + repository: *273 score: type: number node_id: type: string - text_matches: *771 + text_matches: *773 required: - sha - node_id @@ -111274,7 +111639,7 @@ paths: - interactions - created - updated - - *772 + - *774 - *17 - *19 - name: advanced_search @@ -111371,11 +111736,11 @@ paths: type: - string - 'null' - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: type: string state_reason: @@ -111389,7 +111754,7 @@ paths: milestone: anyOf: - type: 'null' - - *387 + - *390 comments: type: integer created_at: @@ -111403,7 +111768,7 @@ paths: - string - 'null' format: date-time - text_matches: *771 + text_matches: *773 pull_request: type: object properties: @@ -111441,7 +111806,7 @@ paths: type: string score: type: number - author_association: *205 + author_association: *206 draft: type: boolean repository: *72 @@ -111452,12 +111817,12 @@ paths: timeline_url: type: string format: uri - type: *351 + type: *355 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *206 + reactions: *207 required: - assignee - closed_at @@ -111626,7 +111991,7 @@ paths: enum: - created - updated - - *772 + - *774 - *17 - *19 responses: @@ -111671,7 +112036,7 @@ paths: - 'null' score: type: number - text_matches: *771 + text_matches: *773 required: - id - node_id @@ -111757,7 +112122,7 @@ paths: - forks - help-wanted-issues - updated - - *772 + - *774 - *17 - *19 responses: @@ -111976,7 +112341,7 @@ paths: license: anyOf: - type: 'null' - - *219 + - *220 permissions: type: object properties: @@ -111994,7 +112359,7 @@ paths: - admin - pull - push - text_matches: *771 + text_matches: *773 temp_clone_token: type: string allow_merge_commit: @@ -112303,7 +112668,7 @@ paths: - string - 'null' format: uri - text_matches: *771 + text_matches: *773 related: type: - array @@ -112498,7 +112863,7 @@ paths: - followers - repositories - joined - - *772 + - *774 - *17 - *19 responses: @@ -112608,7 +112973,7 @@ paths: type: - boolean - 'null' - text_matches: *771 + text_matches: *773 blog: type: - string @@ -112690,7 +113055,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &776 + - &778 name: team_id description: The unique identifier of the team. in: path @@ -112702,9 +113067,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *432 examples: - default: *430 + default: *433 '404': *6 x-github: githubCloudOnly: false @@ -112731,7 +113096,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *776 + - *778 requestBody: required: true content: @@ -112795,16 +113160,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *429 + schema: *432 examples: - default: *430 + default: *433 '201': description: Response content: application/json: - schema: *429 + schema: *432 examples: - default: *430 + default: *433 '404': *6 '422': *15 '403': *27 @@ -112832,7 +113197,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *776 + - *778 responses: '204': description: Response @@ -112863,7 +113228,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *776 + - *778 - *104 - *17 - *19 @@ -112874,9 +113239,9 @@ paths: application/json: schema: type: array - items: *431 + items: *434 examples: - default: *777 + default: *779 headers: Link: *41 x-github: @@ -112905,7 +113270,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *776 + - *778 requestBody: required: true content: @@ -112939,9 +113304,9 @@ paths: description: Response content: application/json: - schema: *431 + schema: *434 examples: - default: *432 + default: *435 x-github: triggersNotification: true githubCloudOnly: false @@ -112968,16 +113333,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *776 - - *433 + - *778 + - *436 responses: '200': description: Response content: application/json: - schema: *431 + schema: *434 examples: - default: *432 + default: *435 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113002,8 +113367,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *776 - - *433 + - *778 + - *436 requestBody: required: false content: @@ -113026,9 +113391,9 @@ paths: description: Response content: application/json: - schema: *431 + schema: *434 examples: - default: *778 + default: *780 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113053,8 +113418,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *776 - - *433 + - *778 + - *436 responses: '204': description: Response @@ -113083,8 +113448,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *776 - - *433 + - *778 + - *436 - *104 - *17 - *19 @@ -113095,9 +113460,9 @@ paths: application/json: schema: type: array - items: *434 + items: *437 examples: - default: *779 + default: *781 headers: Link: *41 x-github: @@ -113126,8 +113491,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *776 - - *433 + - *778 + - *436 requestBody: required: true content: @@ -113149,9 +113514,9 @@ paths: description: Response content: application/json: - schema: *434 + schema: *437 examples: - default: *435 + default: *438 x-github: triggersNotification: true githubCloudOnly: false @@ -113178,17 +113543,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *776 - - *433 + - *778 - *436 + - *439 responses: '200': description: Response content: application/json: - schema: *434 + schema: *437 examples: - default: *435 + default: *438 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113213,9 +113578,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *776 - - *433 + - *778 - *436 + - *439 requestBody: required: true content: @@ -113237,9 +113602,9 @@ paths: description: Response content: application/json: - schema: *434 + schema: *437 examples: - default: *780 + default: *782 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113264,9 +113629,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *776 - - *433 + - *778 - *436 + - *439 responses: '204': description: Response @@ -113295,9 +113660,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: - - *776 - - *433 + - *778 - *436 + - *439 - 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. @@ -113323,9 +113688,9 @@ paths: application/json: schema: type: array - items: *437 + items: *440 examples: - default: *439 + default: *442 headers: Link: *41 x-github: @@ -113354,9 +113719,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: - - *776 - - *433 + - *778 - *436 + - *439 requestBody: required: true content: @@ -113388,9 +113753,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113416,8 +113781,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: - - *776 - - *433 + - *778 + - *436 - 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. @@ -113443,9 +113808,9 @@ paths: application/json: schema: type: array - items: *437 + items: *440 examples: - default: *439 + default: *442 headers: Link: *41 x-github: @@ -113474,8 +113839,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: - - *776 - - *433 + - *778 + - *436 requestBody: required: true content: @@ -113507,9 +113872,9 @@ paths: description: Response content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -113533,7 +113898,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *776 + - *778 - *17 - *19 responses: @@ -113543,9 +113908,9 @@ paths: application/json: schema: type: array - items: *348 + items: *352 examples: - default: *349 + default: *353 headers: Link: *41 x-github: @@ -113571,7 +113936,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *776 + - *778 - name: role description: Filters members returned by their role in the team. in: query @@ -113594,7 +113959,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 '404': *6 @@ -113622,7 +113987,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *776 + - *778 - *132 responses: '204': @@ -113659,7 +114024,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *776 + - *778 - *132 responses: '204': @@ -113699,7 +114064,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *776 + - *778 - *132 responses: '204': @@ -113736,16 +114101,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: - - *776 + - *778 - *132 responses: '200': description: Response content: application/json: - schema: *445 + schema: *448 examples: - response-if-user-is-a-team-maintainer: *781 + response-if-user-is-a-team-maintainer: *783 '404': *6 x-github: githubCloudOnly: false @@ -113778,7 +114143,7 @@ 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: - - *776 + - *778 - *132 requestBody: required: false @@ -113804,9 +114169,9 @@ paths: description: Response content: application/json: - schema: *445 + schema: *448 examples: - response-if-users-membership-with-team-is-now-pending: *782 + response-if-users-membership-with-team-is-now-pending: *784 '403': description: Forbidden if team synchronization is set up '422': @@ -113840,7 +114205,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *776 + - *778 - *132 responses: '204': @@ -113869,7 +114234,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *776 + - *778 - *17 - *19 responses: @@ -113879,9 +114244,9 @@ paths: application/json: schema: type: array - items: *446 + items: *449 examples: - default: *783 + default: *785 headers: Link: *41 '404': *6 @@ -113907,16 +114272,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *776 - - *447 + - *778 + - *450 responses: '200': description: Response content: application/json: - schema: *446 + schema: *449 examples: - default: *784 + default: *786 '404': description: Not Found if project is not managed by this team x-github: @@ -113940,8 +114305,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *776 - - *447 + - *778 + - *450 requestBody: required: false content: @@ -114008,8 +114373,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *776 - - *447 + - *778 + - *450 responses: '204': description: Response @@ -114036,7 +114401,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *776 + - *778 - *17 - *19 responses: @@ -114046,9 +114411,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: *372 + default: *376 headers: Link: *41 '404': *6 @@ -114078,15 +114443,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: - - *776 - - *448 - - *449 + - *778 + - *451 + - *452 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *785 + schema: *787 examples: alternative-response-with-extra-repository-information: value: @@ -114237,9 +114602,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: - - *776 - - *448 - - *449 + - *778 + - *451 + - *452 requestBody: required: false content: @@ -114289,9 +114654,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: - - *776 - - *448 - - *449 + - *778 + - *451 + - *452 responses: '204': description: Response @@ -114320,15 +114685,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: - - *776 + - *778 responses: '200': description: Response content: application/json: - schema: *450 + schema: *453 examples: - default: *451 + default: *454 '403': *27 '404': *6 x-github: @@ -114355,7 +114720,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: - - *776 + - *778 requestBody: required: true content: @@ -114416,7 +114781,7 @@ paths: description: Response content: application/json: - schema: *450 + schema: *453 examples: default: value: @@ -114447,7 +114812,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *776 + - *778 - *17 - *19 responses: @@ -114457,9 +114822,9 @@ paths: application/json: schema: type: array - items: *296 + items: *300 examples: - response-if-child-teams-exist: *786 + response-if-child-teams-exist: *788 headers: Link: *41 '404': *6 @@ -114492,7 +114857,7 @@ paths: application/json: schema: oneOf: - - &788 + - &790 title: Private User description: Private User type: object @@ -114742,7 +115107,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *787 + - *789 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -114902,7 +115267,7 @@ paths: description: Response content: application/json: - schema: *788 + schema: *790 examples: default: value: @@ -114981,7 +115346,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 '304': *35 '404': *6 '403': *27 @@ -115105,9 +115470,9 @@ paths: type: integer codespaces: type: array - items: *356 + items: *360 examples: - default: *357 + default: *361 '304': *35 '500': *38 '401': *23 @@ -115246,17 +115611,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '401': *23 '403': *27 '404': *6 @@ -115300,7 +115665,7 @@ paths: type: integer secrets: type: array - items: &789 + items: &791 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -115342,7 +115707,7 @@ paths: - visibility - selected_repositories_url examples: - default: *557 + default: *558 headers: Link: *41 x-github: @@ -115414,13 +115779,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: - - *279 + - *283 responses: '200': description: Response content: application/json: - schema: *789 + schema: *791 examples: default: value: @@ -115450,7 +115815,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: - - *279 + - *283 requestBody: required: true content: @@ -115495,7 +115860,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -115523,7 +115888,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: - - *279 + - *283 responses: '204': description: Response @@ -115548,7 +115913,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: - - *279 + - *283 responses: '200': description: Response @@ -115564,9 +115929,9 @@ paths: type: integer repositories: type: array - items: *269 + items: *273 examples: - default: *790 + default: *792 '401': *23 '403': *27 '404': *6 @@ -115591,7 +115956,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: - - *279 + - *283 requestBody: required: true content: @@ -115645,7 +116010,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: - - *279 + - *283 - name: repository_id in: path required: true @@ -115678,7 +116043,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: - - *279 + - *283 - name: repository_id in: path required: true @@ -115710,15 +116075,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: - - *358 + - *362 responses: '200': description: Response content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '304': *35 '500': *38 '401': *23 @@ -115744,7 +116109,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: - - *358 + - *362 requestBody: required: false content: @@ -115774,9 +116139,9 @@ paths: description: Response content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '401': *23 '403': *27 '404': *6 @@ -115798,7 +116163,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: - - *358 + - *362 responses: '202': *37 '304': *35 @@ -115827,13 +116192,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: - - *358 + - *362 responses: '202': description: Response content: application/json: - schema: &791 + schema: &793 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -115886,7 +116251,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &792 + default: &794 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -115918,7 +116283,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *358 + - *362 - name: export_id in: path required: true @@ -115931,9 +116296,9 @@ paths: description: Response content: application/json: - schema: *791 + schema: *793 examples: - default: *792 + default: *794 '404': *6 x-github: githubCloudOnly: false @@ -115954,7 +116319,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *358 + - *362 responses: '200': description: Response @@ -115970,9 +116335,9 @@ paths: type: integer machines: type: array - items: *556 + items: *557 examples: - default: *793 + default: *795 '304': *35 '500': *38 '401': *23 @@ -116001,7 +116366,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: - - *358 + - *362 requestBody: required: true content: @@ -116057,11 +116422,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *461 + repository: *462 machine: anyOf: - type: 'null' - - *556 + - *557 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -116858,15 +117223,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: - - *358 + - *362 responses: '200': description: Response content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '304': *35 '500': *38 '400': *14 @@ -116898,15 +117263,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: - - *358 + - *362 responses: '200': description: Response content: application/json: - schema: *356 + schema: *360 examples: - default: *555 + default: *556 '500': *38 '401': *23 '403': *27 @@ -116936,9 +117301,9 @@ paths: application/json: schema: type: array - items: *366 + items: *370 examples: - default: &804 + default: &806 value: - id: 197 name: hello_docker @@ -117039,7 +117404,7 @@ paths: application/json: schema: type: array - items: &794 + items: &796 title: Email description: Email type: object @@ -117109,9 +117474,9 @@ paths: application/json: schema: type: array - items: *794 + items: *796 examples: - default: &806 + default: &808 value: - email: octocat@github.com verified: true @@ -117188,7 +117553,7 @@ paths: application/json: schema: type: array - items: *794 + items: *796 examples: default: value: @@ -117300,7 +117665,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 '304': *35 @@ -117333,7 +117698,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 '304': *35 @@ -117446,7 +117811,7 @@ paths: application/json: schema: type: array - items: &795 + items: &797 title: GPG Key description: A unique encryption key type: object @@ -117591,7 +117956,7 @@ paths: - subkeys - revoked examples: - default: &820 + default: &822 value: - id: 3 name: Octocat's GPG Key @@ -117676,9 +118041,9 @@ paths: description: Response content: application/json: - schema: *795 + schema: *797 examples: - default: &796 + default: &798 value: id: 3 name: Octocat's GPG Key @@ -117735,7 +118100,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: - - &797 + - &799 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -117747,9 +118112,9 @@ paths: description: Response content: application/json: - schema: *795 + schema: *797 examples: - default: *796 + default: *798 '404': *6 '304': *35 '403': *27 @@ -117772,7 +118137,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: - - *797 + - *799 responses: '204': description: Response @@ -117963,7 +118328,7 @@ paths: type: array items: *72 examples: - default: *264 + default: *268 headers: Link: *41 '404': *6 @@ -117988,7 +118353,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *263 + - *267 responses: '204': description: Response @@ -118014,7 +118379,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *263 + - *267 responses: '204': description: Response @@ -118048,12 +118413,12 @@ paths: application/json: schema: anyOf: - - *346 + - *350 - type: object properties: {} additionalProperties: false examples: - default: *347 + default: *351 '204': description: Response when there are no restrictions x-github: @@ -118077,7 +118442,7 @@ paths: required: true content: application/json: - schema: *633 + schema: *634 examples: default: value: @@ -118088,7 +118453,7 @@ paths: description: Response content: application/json: - schema: *346 + schema: *350 examples: default: value: @@ -118169,7 +118534,7 @@ paths: - closed - all default: open - - *354 + - *358 - name: sort description: What to sort results by. in: query @@ -118182,7 +118547,7 @@ paths: - comments default: created - *104 - - *208 + - *209 - *17 - *19 responses: @@ -118192,9 +118557,9 @@ paths: application/json: schema: type: array - items: *218 + items: *219 examples: - default: *355 + default: *359 headers: Link: *41 '404': *6 @@ -118227,7 +118592,7 @@ paths: application/json: schema: type: array - items: &798 + items: &800 title: Key description: Key type: object @@ -118330,9 +118695,9 @@ paths: description: Response content: application/json: - schema: *798 + schema: *800 examples: - default: &799 + default: &801 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -118365,15 +118730,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: - - *660 + - *662 responses: '200': description: Response content: application/json: - schema: *798 + schema: *800 examples: - default: *799 + default: *801 '404': *6 '304': *35 '403': *27 @@ -118396,7 +118761,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: - - *660 + - *662 responses: '204': description: Response @@ -118429,7 +118794,7 @@ paths: application/json: schema: type: array - items: &800 + items: &802 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -118497,7 +118862,7 @@ paths: - id - type - login - plan: *221 + plan: *222 required: - billing_cycle - next_billing_date @@ -118508,7 +118873,7 @@ paths: - account - plan examples: - default: &801 + default: &803 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -118570,9 +118935,9 @@ paths: application/json: schema: type: array - items: *800 + items: *802 examples: - default: *801 + default: *803 headers: Link: *41 '304': *35 @@ -118612,7 +118977,7 @@ paths: application/json: schema: type: array - items: *359 + items: *363 examples: default: value: @@ -118720,7 +119085,7 @@ paths: description: Response content: application/json: - schema: *359 + schema: *363 examples: default: value: @@ -118803,7 +119168,7 @@ paths: description: Response content: application/json: - schema: *359 + schema: *363 examples: default: value: @@ -118871,7 +119236,7 @@ paths: application/json: schema: type: array - items: *361 + items: *365 examples: default: value: @@ -119133,7 +119498,7 @@ paths: description: Response content: application/json: - schema: *361 + schema: *365 examples: default: value: @@ -119313,7 +119678,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *362 + - *366 - name: exclude in: query required: false @@ -119326,7 +119691,7 @@ paths: description: Response content: application/json: - schema: *361 + schema: *365 examples: default: value: @@ -119520,7 +119885,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *362 + - *366 responses: '302': description: Response @@ -119546,7 +119911,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *362 + - *366 responses: '204': description: Response @@ -119575,8 +119940,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *362 - - *802 + - *366 + - *804 responses: '204': description: Response @@ -119600,7 +119965,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *362 + - *366 - *17 - *19 responses: @@ -119610,9 +119975,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: *372 + default: *376 headers: Link: *41 '404': *6 @@ -119649,7 +120014,7 @@ paths: type: array items: *67 examples: - default: *234 + default: *235 headers: Link: *41 '304': *35 @@ -119691,7 +120056,7 @@ paths: - docker - nuget - container - - *803 + - *805 - *19 - *17 responses: @@ -119701,10 +120066,10 @@ paths: application/json: schema: type: array - items: *366 + items: *370 examples: - default: *804 - '400': *805 + default: *806 + '400': *807 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -119724,16 +120089,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: - - *368 - - *369 + - *372 + - *373 responses: '200': description: Response content: application/json: - schema: *366 + schema: *370 examples: - default: &821 + default: &823 value: id: 40201 name: octo-name @@ -119846,8 +120211,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: - - *368 - - *369 + - *372 + - *373 responses: '204': description: Response @@ -119877,8 +120242,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: - - *368 - - *369 + - *372 + - *373 - name: token description: package token schema: @@ -119910,8 +120275,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: - - *368 - - *369 + - *372 + - *373 - *19 - *17 - name: state @@ -119931,7 +120296,7 @@ paths: application/json: schema: type: array - items: *370 + items: *374 examples: default: value: @@ -119980,15 +120345,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: - - *368 - - *369 - - *371 + - *372 + - *373 + - *375 responses: '200': description: Response content: application/json: - schema: *370 + schema: *374 examples: default: value: @@ -120024,9 +120389,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: - - *368 - - *369 - - *371 + - *372 + - *373 + - *375 responses: '204': description: Response @@ -120056,9 +120421,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: - - *368 - - *369 - - *371 + - *372 + - *373 + - *375 responses: '204': description: Response @@ -120070,99 +120435,6 @@ paths: enabledForGitHubApps: false category: packages subcategory: packages - "/user/projects": - post: - summary: Create a user 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: - - projects-classic - operationId: projects-classic/create-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-a-user-project - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - required: - - name - type: object - examples: - default: - summary: Create a new project - value: - name: My Projects - body: A board to manage my personal projects. - responses: - '201': - description: Response - content: - application/json: - schema: *382 - examples: - default: - value: - owner_url: https://api.github.com/users/octocat - url: https://api.github.com/projects/1002603 - html_url: https://github.com/users/octocat/projects/1 - columns_url: https://api.github.com/projects/1002603/columns - id: 1002603 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - name: My Projects - body: A board to manage my personal projects. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - '304': *35 - '403': *27 - '401': *23 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/user/public_emails": get: summary: List public email addresses for the authenticated user @@ -120188,9 +120460,9 @@ paths: application/json: schema: type: array - items: *794 + items: *796 examples: - default: *806 + default: *808 headers: Link: *41 '304': *35 @@ -120303,7 +120575,7 @@ paths: type: array items: *72 examples: - default: &813 + default: &815 summary: Default response value: - id: 1296269 @@ -120621,9 +120893,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *462 examples: - default: *463 + default: *464 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -120661,9 +120933,9 @@ paths: application/json: schema: type: array - items: *635 + items: *636 examples: - default: *807 + default: *809 headers: Link: *41 '304': *35 @@ -120686,7 +120958,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *350 + - *354 responses: '204': description: Response @@ -120709,7 +120981,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *350 + - *354 responses: '204': description: Response @@ -120742,7 +121014,7 @@ paths: application/json: schema: type: array - items: &808 + items: &810 title: Social account description: Social media account type: object @@ -120759,7 +121031,7 @@ paths: - provider - url examples: - default: &809 + default: &811 value: - provider: twitter url: https://twitter.com/github @@ -120822,9 +121094,9 @@ paths: application/json: schema: type: array - items: *808 + items: *810 examples: - default: *809 + default: *811 '422': *15 '304': *35 '404': *6 @@ -120912,7 +121184,7 @@ paths: application/json: schema: type: array - items: &810 + items: &812 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -120932,7 +121204,7 @@ paths: - title - created_at examples: - default: &826 + default: &828 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -120999,9 +121271,9 @@ paths: description: Response content: application/json: - schema: *810 + schema: *812 examples: - default: &811 + default: &813 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -121032,7 +121304,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: - - &812 + - &814 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -121044,9 +121316,9 @@ paths: description: Response content: application/json: - schema: *810 + schema: *812 examples: - default: *811 + default: *813 '404': *6 '304': *35 '403': *27 @@ -121069,7 +121341,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: - - *812 + - *814 responses: '204': description: Response @@ -121098,7 +121370,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: - - &827 + - &829 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 @@ -121123,11 +121395,11 @@ paths: type: array items: *72 examples: - default-response: *813 + default-response: *815 application/vnd.github.v3.star+json: schema: type: array - items: &828 + items: &830 title: Starred Repository description: Starred Repository type: object @@ -121283,8 +121555,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: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response if this repository is starred by you @@ -121312,8 +121584,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: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -121337,8 +121609,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: - - *448 - - *449 + - *451 + - *452 responses: '204': description: Response @@ -121371,9 +121643,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: *372 + default: *376 headers: Link: *41 '304': *35 @@ -121410,7 +121682,7 @@ paths: application/json: schema: type: array - items: *429 + items: *432 examples: default: value: @@ -121488,7 +121760,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *223 + - *224 responses: '200': description: Response @@ -121496,10 +121768,10 @@ paths: application/json: schema: oneOf: - - *788 - - *787 + - *790 + - *789 examples: - default-response: &815 + default-response: &817 summary: Default response value: login: octocat @@ -121534,7 +121806,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &816 + response-with-git-hub-plan-information: &818 summary: Response with GitHub plan information value: login: octocat @@ -121594,7 +121866,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *814 + - *816 - *17 responses: '200': @@ -121605,7 +121877,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: example: ; rel="next" @@ -121643,11 +121915,11 @@ paths: application/json: schema: oneOf: - - *788 - - *787 + - *790 + - *789 examples: - default-response: *815 - response-with-git-hub-plan-information: *816 + default-response: *817 + response-with-git-hub-plan-information: *818 '404': *6 x-github: githubCloudOnly: false @@ -121697,8 +121969,8 @@ paths: required: - subject_digests examples: - default: *817 - withPredicateType: *818 + default: *819 + withPredicateType: *820 responses: '200': description: Response @@ -121752,7 +122024,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *819 + default: *821 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -121957,12 +122229,12 @@ paths: initiator: type: string examples: - default: *501 + default: *502 '201': description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -121996,9 +122268,9 @@ paths: application/json: schema: type: array - items: *366 + items: *370 examples: - default: *804 + default: *806 '403': *27 '401': *23 x-github: @@ -122031,7 +122303,7 @@ paths: application/json: schema: type: array - items: *229 + items: *230 examples: default: value: @@ -122104,7 +122376,7 @@ paths: application/json: schema: type: array - items: *229 + items: *230 examples: default: value: @@ -122191,7 +122463,7 @@ paths: application/json: schema: type: array - items: *229 + items: *230 examples: default: value: @@ -122261,7 +122533,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 x-github: @@ -122292,7 +122564,7 @@ paths: type: array items: *4 examples: - default: *200 + default: *201 headers: Link: *41 x-github: @@ -122339,7 +122611,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - *132 - - *208 + - *209 - *17 - *19 responses: @@ -122349,9 +122621,9 @@ paths: application/json: schema: type: array - items: *209 + items: *210 examples: - default: *210 + default: *211 headers: Link: *41 '422': *15 @@ -122382,9 +122654,9 @@ paths: application/json: schema: type: array - items: *795 + items: *797 examples: - default: *820 + default: *822 headers: Link: *41 x-github: @@ -122488,7 +122760,7 @@ paths: application/json: schema: *20 examples: - default: *632 + default: *633 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122574,7 +122846,7 @@ paths: type: array items: *67 examples: - default: *234 + default: *235 headers: Link: *41 x-github: @@ -122613,7 +122885,7 @@ paths: - docker - nuget - container - - *803 + - *805 - *132 - *19 - *17 @@ -122624,12 +122896,12 @@ paths: application/json: schema: type: array - items: *366 + items: *370 examples: - default: *804 + default: *806 '403': *27 '401': *23 - '400': *805 + '400': *807 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122649,17 +122921,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *368 - - *369 + - *372 + - *373 - *132 responses: '200': description: Response content: application/json: - schema: *366 + schema: *370 examples: - default: *821 + default: *823 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -122680,8 +122952,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *368 - - *369 + - *372 + - *373 - *132 responses: '204': @@ -122714,8 +122986,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *368 - - *369 + - *372 + - *373 - *132 - name: token description: package token @@ -122748,8 +123020,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-a-user parameters: - - *368 - - *369 + - *372 + - *373 - *132 responses: '200': @@ -122758,7 +123030,7 @@ paths: application/json: schema: type: array - items: *370 + items: *374 examples: default: value: @@ -122816,16 +123088,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: - - *368 - - *369 - - *371 + - *372 + - *373 + - *375 - *132 responses: '200': description: Response content: application/json: - schema: *370 + schema: *374 examples: default: value: @@ -122860,10 +123132,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *368 - - *369 + - *372 + - *373 - *132 - - *371 + - *375 responses: '204': description: Response @@ -122895,10 +123167,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *368 - - *369 + - *372 + - *373 - *132 - - *371 + - *375 responses: '204': description: Response @@ -122910,87 +123182,6 @@ paths: enabledForGitHubApps: false category: packages subcategory: packages - "/users/{username}/projects": - get: - summary: List user 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: - - projects-classic - operationId: projects-classic/list-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-user-projects - parameters: - - *132 - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *382 - examples: - default: - value: - - owner_url: https://api.github.com/users/octocat - url: https://api.github.com/projects/1002603 - html_url: https://github.com/users/octocat/projects/1 - columns_url: https://api.github.com/projects/1002603/columns - id: 1002603 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - name: My Projects - body: A board to manage my personal projects. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - headers: - Link: *41 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/users/{username}/projectsV2": get: summary: List projects for user @@ -123020,9 +123211,9 @@ paths: application/json: schema: type: array - items: *383 + items: *386 examples: - default: *384 + default: *387 headers: Link: *41 '304': *35 @@ -123044,16 +123235,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-user parameters: - - *385 + - *388 - *132 responses: '200': description: Response content: application/json: - schema: *383 + schema: *386 examples: - default: *384 + default: *387 headers: Link: *41 '304': *35 @@ -123075,7 +123266,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-user parameters: - - *385 + - *388 - *132 - *17 - *102 @@ -123087,9 +123278,9 @@ paths: application/json: schema: type: array - items: *386 + items: *389 examples: - default: *822 + default: *824 headers: Link: *41 '304': *35 @@ -123111,17 +123302,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - - *385 - - *823 + - *388 + - *825 - *132 responses: '200': description: Response content: application/json: - schema: *386 + schema: *389 examples: - default: *824 + default: *826 headers: Link: *41 '304': *35 @@ -123144,7 +123335,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#list-items-for-a-user-owned-project parameters: - - *385 + - *388 - *132 - *102 - *103 @@ -123177,9 +123368,9 @@ paths: application/json: schema: type: array - items: *391 + items: *394 examples: - default: *392 + default: *395 headers: Link: *41 '304': *35 @@ -123201,7 +123392,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-user-owned-project parameters: - *132 - - *385 + - *388 requestBody: required: true description: Details of the item to add to the project. @@ -123238,10 +123429,10 @@ paths: description: Response content: application/json: - schema: *825 + schema: *827 examples: - issue: *390 - pull_request: *390 + issue: *393 + pull_request: *393 '304': *35 '403': *27 '401': *23 @@ -123261,9 +123452,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: - - *385 + - *388 - *132 - - *393 + - *396 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -123283,9 +123474,9 @@ paths: description: Response content: application/json: - schema: *391 + schema: *394 examples: - default: *392 + default: *395 headers: Link: *41 '304': *35 @@ -123306,9 +123497,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-user parameters: - - *385 + - *388 - *132 - - *393 + - *396 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -123381,13 +123572,13 @@ paths: description: Response content: application/json: - schema: *391 + schema: *394 examples: - text_field: *392 - number_field: *392 - date_field: *392 - single_select_field: *392 - iteration_field: *392 + text_field: *395 + number_field: *395 + date_field: *395 + single_select_field: *395 + iteration_field: *395 '401': *23 '403': *27 '404': *6 @@ -123407,9 +123598,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-user parameters: - - *385 + - *388 - *132 - - *393 + - *396 responses: '204': description: Response @@ -123446,7 +123637,7 @@ paths: application/json: schema: type: array - items: *229 + items: *230 examples: default: value: @@ -123521,7 +123712,7 @@ paths: application/json: schema: type: array - items: *229 + items: *230 examples: default: value: @@ -123627,9 +123818,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: *372 + default: *376 headers: Link: *41 x-github: @@ -123659,9 +123850,9 @@ paths: description: Response content: application/json: - schema: *416 + schema: *419 examples: - default: *417 + default: *420 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -123689,9 +123880,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *424 examples: - default: *422 + default: *425 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -123712,11 +123903,11 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-a-user parameters: - *132 - - *190 - - *192 - *191 - - *236 - - *194 + - *193 + - *192 + - *240 + - *195 responses: '200': description: Response when getting a billing premium request usage report @@ -123852,9 +124043,9 @@ paths: description: Response content: application/json: - schema: *423 + schema: *426 examples: - default: *424 + default: *427 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -123875,9 +124066,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - *132 - - *190 - - *237 - *191 + - *241 + - *192 responses: '200': description: Response when getting a billing usage report @@ -123956,7 +124147,7 @@ paths: subcategory: enhanced-billing "/users/{username}/settings/billing/usage/summary": get: - summary: Get billing usage summary report for a user + summary: Get billing usage summary for a user description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. @@ -123969,18 +124160,18 @@ paths: operationId: billing/get-github-billing-usage-summary-report-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-report-for-a-user + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-for-a-user parameters: - *132 - - *190 - - *192 - *191 - - *240 - - *194 - - *241 + - *193 + - *192 + - *244 + - *195 + - *245 responses: '200': - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -124111,9 +124302,9 @@ paths: application/json: schema: type: array - items: *808 + items: *810 examples: - default: *809 + default: *811 headers: Link: *41 x-github: @@ -124143,9 +124334,9 @@ paths: application/json: schema: type: array - items: *810 + items: *812 examples: - default: *826 + default: *828 headers: Link: *41 x-github: @@ -124170,7 +124361,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - *132 - - *827 + - *829 - *104 - *17 - *19 @@ -124182,11 +124373,11 @@ paths: schema: anyOf: - type: array - items: *828 + items: *830 - type: array items: *72 examples: - default-response: *813 + default-response: *815 headers: Link: *41 x-github: @@ -124215,9 +124406,9 @@ paths: application/json: schema: type: array - items: *269 + items: *273 examples: - default: *372 + default: *376 headers: Link: *41 x-github: @@ -124346,7 +124537,7 @@ webhooks: type: string enum: - disabled - enterprise: &829 + enterprise: &831 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -124415,7 +124606,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &830 + installation: &832 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -124436,7 +124627,7 @@ webhooks: required: - id - node_id - organization: &831 + organization: &833 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -124509,7 +124700,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &832 + repository: &834 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -124538,7 +124729,7 @@ webhooks: license: anyOf: - type: 'null' - - *219 + - *220 organization: anyOf: - type: 'null' @@ -125422,10 +125613,10 @@ webhooks: type: string enum: - enabled - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -125501,11 +125692,11 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - rule: &833 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + rule: &835 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) @@ -125728,11 +125919,11 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - rule: *833 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + rule: *835 sender: *4 required: - action @@ -125920,11 +126111,11 @@ webhooks: - everyone required: - from - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - rule: *833 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + rule: *835 sender: *4 required: - action @@ -125995,7 +126186,7 @@ webhooks: required: true content: application/json: - schema: &836 + schema: &838 title: Exemption request cancellation event type: object properties: @@ -126003,11 +126194,11 @@ webhooks: type: string enum: - cancelled - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - exemption_request: &834 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + exemption_request: &836 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -126245,7 +126436,7 @@ webhooks: - array - 'null' description: The responses to the exemption request. - items: &835 + items: &837 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -126355,7 +126546,7 @@ webhooks: required: true content: application/json: - schema: &837 + schema: &839 title: Exemption request completed event type: object properties: @@ -126363,11 +126554,11 @@ webhooks: type: string enum: - completed - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - exemption_request: *834 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + exemption_request: *836 sender: *4 required: - action @@ -126437,7 +126628,7 @@ webhooks: required: true content: application/json: - schema: &838 + schema: &840 title: Exemption request created event type: object properties: @@ -126445,11 +126636,11 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - exemption_request: *834 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + exemption_request: *836 sender: *4 required: - action @@ -126519,7 +126710,7 @@ webhooks: required: true content: application/json: - schema: &839 + schema: &841 title: Exemption response dismissed event type: object properties: @@ -126527,12 +126718,12 @@ webhooks: type: string enum: - response_dismissed - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - exemption_request: *834 - exemption_response: *835 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + exemption_request: *836 + exemption_response: *837 sender: *4 required: - action @@ -126604,7 +126795,7 @@ webhooks: required: true content: application/json: - schema: &840 + schema: &842 title: Exemption response submitted event type: object properties: @@ -126612,12 +126803,12 @@ webhooks: type: string enum: - response_submitted - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - exemption_request: *834 - exemption_response: *835 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + exemption_request: *836 + exemption_response: *837 sender: *4 required: - action @@ -126690,7 +126881,7 @@ webhooks: required: true content: application/json: - schema: *836 + schema: *838 responses: '200': description: Return a 200 status to indicate that the data was received @@ -126757,7 +126948,7 @@ webhooks: required: true content: application/json: - schema: *837 + schema: *839 responses: '200': description: Return a 200 status to indicate that the data was received @@ -126824,7 +127015,7 @@ webhooks: required: true content: application/json: - schema: *838 + schema: *840 responses: '200': description: Return a 200 status to indicate that the data was received @@ -126891,7 +127082,7 @@ webhooks: required: true content: application/json: - schema: *839 + schema: *841 responses: '200': description: Return a 200 status to indicate that the data was received @@ -126959,7 +127150,7 @@ webhooks: required: true content: application/json: - schema: *840 + schema: *842 responses: '200': description: Return a 200 status to indicate that the data was received @@ -127037,7 +127228,7 @@ webhooks: type: string enum: - completed - check_run: &842 + check_run: &844 title: CheckRun description: A check performed on the code of a given code change type: object @@ -127102,8 +127293,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *518 - repository: *269 + items: *519 + repository: *273 status: type: string enum: @@ -127147,7 +127338,7 @@ webhooks: - examples: - neutral - deployment: *841 + deployment: *843 details_url: type: string examples: @@ -127207,7 +127398,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *518 + items: *519 started_at: type: string format: date-time @@ -127245,10 +127436,10 @@ webhooks: - output - app - pull_requests - installation: *830 - enterprise: *829 - organization: *831 - repository: *832 + installation: *832 + enterprise: *831 + organization: *833 + repository: *834 sender: *4 required: - check_run @@ -127641,11 +127832,11 @@ webhooks: type: string enum: - created - check_run: *842 - installation: *830 - enterprise: *829 - organization: *831 - repository: *832 + check_run: *844 + installation: *832 + enterprise: *831 + organization: *833 + repository: *834 sender: *4 required: - check_run @@ -128041,11 +128232,11 @@ webhooks: type: string enum: - requested_action - check_run: *842 - installation: *830 - enterprise: *829 - organization: *831 - repository: *832 + check_run: *844 + installation: *832 + enterprise: *831 + organization: *833 + repository: *834 requested_action: description: The action requested by the user. type: object @@ -128450,11 +128641,11 @@ webhooks: type: string enum: - rerequested - check_run: *842 - installation: *830 - enterprise: *829 - organization: *831 - repository: *832 + check_run: *844 + installation: *832 + enterprise: *831 + organization: *833 + repository: *834 sender: *4 required: - check_run @@ -129446,10 +129637,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -130134,10 +130325,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -130816,10 +131007,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -130988,7 +131179,7 @@ webhooks: required: - login - id - dismissed_comment: *530 + dismissed_comment: *531 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -131140,20 +131331,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &843 + commit_oid: &845 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: *829 - installation: *830 - organization: *831 - ref: &844 + enterprise: *831 + installation: *832 + organization: *833 + ref: &846 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: *832 + repository: *834 sender: *4 required: - action @@ -131320,7 +131511,7 @@ webhooks: required: - login - id - dismissed_comment: *530 + dismissed_comment: *531 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -131561,12 +131752,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *843 - enterprise: *829 - installation: *830 - organization: *831 - ref: *844 - repository: *832 + commit_oid: *845 + enterprise: *831 + installation: *832 + organization: *833 + ref: *846 + repository: *834 sender: *4 required: - action @@ -131664,7 +131855,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *530 + dismissed_comment: *531 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -131849,12 +132040,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *843 - enterprise: *829 - installation: *830 - organization: *831 - ref: *844 - repository: *832 + commit_oid: *845 + enterprise: *831 + installation: *832 + organization: *833 + ref: *846 + repository: *834 sender: *4 required: - action @@ -132023,7 +132214,7 @@ webhooks: required: - login - id - dismissed_comment: *530 + dismissed_comment: *531 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -132200,12 +132391,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *843 - enterprise: *829 - installation: *830 - organization: *831 - ref: *844 - repository: *832 + commit_oid: *845 + enterprise: *831 + installation: *832 + organization: *833 + ref: *846 + repository: *834 sender: *4 required: - action @@ -132308,7 +132499,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *530 + dismissed_comment: *531 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -132488,9 +132679,9 @@ webhooks: type: - string - 'null' - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -132498,7 +132689,7 @@ webhooks: type: - string - 'null' - repository: *832 + repository: *834 sender: *4 required: - action @@ -132597,7 +132788,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *530 + dismissed_comment: *531 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -132744,12 +132935,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *843 - enterprise: *829 - installation: *830 - organization: *831 - ref: *844 - repository: *832 + commit_oid: *845 + enterprise: *831 + installation: *832 + organization: *833 + ref: *846 + repository: *834 sender: *4 required: - action @@ -133011,10 +133202,10 @@ webhooks: - updated_at - author_association - body - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -133095,18 +133286,18 @@ webhooks: type: - string - 'null' - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *831 - pusher_type: &845 + organization: *833 + pusher_type: &847 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &846 + ref: &848 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -133116,7 +133307,7 @@ webhooks: enum: - tag - branch - repository: *832 + repository: *834 sender: *4 required: - ref @@ -133199,9 +133390,9 @@ webhooks: enum: - created definition: *146 - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 sender: *4 required: - action @@ -133286,9 +133477,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 sender: *4 required: - action @@ -133366,9 +133557,9 @@ webhooks: enum: - promote_to_enterprise definition: *146 - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 sender: *4 required: - action @@ -133446,9 +133637,9 @@ webhooks: enum: - updated definition: *146 - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 sender: *4 required: - action @@ -133525,10 +133716,10 @@ webhooks: type: string enum: - updated - enterprise: *829 - installation: *830 - repository: *832 - organization: *831 + enterprise: *831 + installation: *832 + repository: *834 + organization: *833 sender: *4 new_property_values: type: array @@ -133613,18 +133804,18 @@ webhooks: title: delete event type: object properties: - enterprise: *829 - installation: *830 - organization: *831 - pusher_type: *845 - ref: *846 + enterprise: *831 + installation: *832 + organization: *833 + pusher_type: *847 + ref: *848 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *832 + repository: *834 sender: *4 required: - ref @@ -133708,11 +133899,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *582 - installation: *830 - organization: *831 - enterprise: *829 - repository: *832 + alert: *583 + installation: *832 + organization: *833 + enterprise: *831 + repository: *834 sender: *4 required: - action @@ -133796,11 +133987,11 @@ webhooks: type: string enum: - auto_reopened - alert: *582 - installation: *830 - organization: *831 - enterprise: *829 - repository: *832 + alert: *583 + installation: *832 + organization: *833 + enterprise: *831 + repository: *834 sender: *4 required: - action @@ -133884,11 +134075,11 @@ webhooks: type: string enum: - created - alert: *582 - installation: *830 - organization: *831 - enterprise: *829 - repository: *832 + alert: *583 + installation: *832 + organization: *833 + enterprise: *831 + repository: *834 sender: *4 required: - action @@ -133970,11 +134161,11 @@ webhooks: type: string enum: - dismissed - alert: *582 - installation: *830 - organization: *831 - enterprise: *829 - repository: *832 + alert: *583 + installation: *832 + organization: *833 + enterprise: *831 + repository: *834 sender: *4 required: - action @@ -134056,11 +134247,11 @@ webhooks: type: string enum: - fixed - alert: *582 - installation: *830 - organization: *831 - enterprise: *829 - repository: *832 + alert: *583 + installation: *832 + organization: *833 + enterprise: *831 + repository: *834 sender: *4 required: - action @@ -134143,11 +134334,11 @@ webhooks: type: string enum: - reintroduced - alert: *582 - installation: *830 - organization: *831 - enterprise: *829 - repository: *832 + alert: *583 + installation: *832 + organization: *833 + enterprise: *831 + repository: *834 sender: *4 required: - action @@ -134229,11 +134420,11 @@ webhooks: type: string enum: - reopened - alert: *582 - installation: *830 - organization: *831 - enterprise: *829 - repository: *832 + alert: *583 + installation: *832 + organization: *833 + enterprise: *831 + repository: *834 sender: *4 required: - action @@ -134310,9 +134501,9 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - key: &847 + enterprise: *831 + installation: *832 + key: &849 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -134350,8 +134541,8 @@ webhooks: - verified - created_at - read_only - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -134428,11 +134619,11 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - key: *847 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + key: *849 + organization: *833 + repository: *834 sender: *4 required: - action @@ -135004,12 +135195,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - workflow: &851 + workflow: &853 title: Workflow type: - object @@ -135747,13 +135938,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *588 + deployment: *589 pull_requests: type: array - items: *680 - repository: *832 - organization: *831 - installation: *830 + items: *682 + repository: *834 + organization: *833 + installation: *832 sender: *4 responses: '200': @@ -135824,7 +136015,7 @@ webhooks: type: string enum: - approved - approver: &848 + approver: &850 type: object properties: avatar_url: @@ -135867,11 +136058,11 @@ webhooks: type: string comment: type: string - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - reviewers: &849 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + reviewers: &851 type: array items: type: object @@ -135952,7 +136143,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &850 + workflow_job_run: &852 type: object properties: conclusion: @@ -136698,18 +136889,18 @@ webhooks: type: string enum: - rejected - approver: *848 + approver: *850 comment: type: string - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - reviewers: *849 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + reviewers: *851 sender: *4 since: type: string - workflow_job_run: *850 + workflow_job_run: *852 workflow_job_runs: type: array items: @@ -137426,13 +137617,13 @@ webhooks: type: string enum: - requested - enterprise: *829 + enterprise: *831 environment: type: string - installation: *830 - organization: *831 - repository: *832 - requestor: &856 + installation: *832 + organization: *833 + repository: *834 + requestor: &858 title: User type: - object @@ -139375,12 +139566,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - workflow: *851 + workflow: *853 workflow_run: title: Deployment Workflow Run type: @@ -140071,7 +140262,7 @@ webhooks: type: string enum: - answered - answer: &854 + answer: &856 type: object properties: author_association: @@ -140231,7 +140422,7 @@ webhooks: - created_at - updated_at - body - discussion: &852 + discussion: &854 title: Discussion description: A Discussion in a repository. type: object @@ -140527,7 +140718,7 @@ webhooks: - id labels: type: array - items: *643 + items: *645 required: - repository_url - category @@ -140549,10 +140740,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -140679,11 +140870,11 @@ webhooks: - from required: - category - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -140766,11 +140957,11 @@ webhooks: type: string enum: - closed - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -140852,7 +141043,7 @@ webhooks: type: string enum: - created - comment: &853 + comment: &855 type: object properties: author_association: @@ -141012,11 +141203,11 @@ webhooks: - updated_at - body - reactions - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141099,12 +141290,12 @@ webhooks: type: string enum: - deleted - comment: *853 - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + comment: *855 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141199,12 +141390,12 @@ webhooks: - from required: - body - comment: *853 - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + comment: *855 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141288,11 +141479,11 @@ webhooks: type: string enum: - created - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141374,11 +141565,11 @@ webhooks: type: string enum: - deleted - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141478,11 +141669,11 @@ webhooks: type: string required: - from - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141564,10 +141755,10 @@ webhooks: type: string enum: - labeled - discussion: *852 - enterprise: *829 - installation: *830 - label: &855 + discussion: *854 + enterprise: *831 + installation: *832 + label: &857 title: Label type: object properties: @@ -141600,8 +141791,8 @@ webhooks: - color - default - description - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141684,11 +141875,11 @@ webhooks: type: string enum: - locked - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141770,11 +141961,11 @@ webhooks: type: string enum: - pinned - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141856,11 +142047,11 @@ webhooks: type: string enum: - reopened - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -141945,16 +142136,16 @@ webhooks: changes: type: object properties: - new_discussion: *852 - new_repository: *832 + new_discussion: *854 + new_repository: *834 required: - new_discussion - new_repository - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -142037,10 +142228,10 @@ webhooks: type: string enum: - unanswered - discussion: *852 - old_answer: *854 - organization: *831 - repository: *832 + discussion: *854 + old_answer: *856 + organization: *833 + repository: *834 sender: *4 required: - action @@ -142122,12 +142313,12 @@ webhooks: type: string enum: - unlabeled - discussion: *852 - enterprise: *829 - installation: *830 - label: *855 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + label: *857 + organization: *833 + repository: *834 sender: *4 required: - action @@ -142210,11 +142401,11 @@ webhooks: type: string enum: - unlocked - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -142296,11 +142487,11 @@ webhooks: type: string enum: - unpinned - discussion: *852 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + discussion: *854 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -142369,7 +142560,7 @@ webhooks: required: true content: application/json: - schema: *838 + schema: *840 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142432,7 +142623,7 @@ webhooks: required: true content: application/json: - schema: *840 + schema: *842 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142498,7 +142689,7 @@ webhooks: required: true content: application/json: - schema: *836 + schema: *838 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142564,7 +142755,7 @@ webhooks: required: true content: application/json: - schema: *837 + schema: *839 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142630,7 +142821,7 @@ webhooks: required: true content: application/json: - schema: *838 + schema: *840 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142696,7 +142887,7 @@ webhooks: required: true content: application/json: - schema: *839 + schema: *841 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142762,7 +142953,7 @@ webhooks: required: true content: application/json: - schema: *840 + schema: *842 responses: '200': description: Return a 200 status to indicate that the data was received @@ -142829,7 +143020,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *829 + enterprise: *831 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -143507,9 +143698,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *830 - organization: *831 - repository: *832 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - forkee @@ -143655,9 +143846,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 pages: description: The pages that were updated. type: array @@ -143695,7 +143886,7 @@ webhooks: - action - sha - html_url - repository: *832 + repository: *834 sender: *4 required: - pages @@ -143771,10 +143962,10 @@ webhooks: type: string enum: - created - enterprise: *829 + enterprise: *831 installation: *20 - organization: *831 - repositories: &857 + organization: *833 + repositories: &859 description: An array of repository objects that the installation can access. type: array @@ -143800,8 +143991,8 @@ webhooks: - name - full_name - private - repository: *832 - requester: *856 + repository: *834 + requester: *858 sender: *4 required: - action @@ -143876,11 +144067,11 @@ webhooks: type: string enum: - deleted - enterprise: *829 + enterprise: *831 installation: *20 - organization: *831 - repositories: *857 - repository: *832 + organization: *833 + repositories: *859 + repository: *834 requester: type: - 'null' @@ -143957,11 +144148,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *829 + enterprise: *831 installation: *20 - organization: *831 - repositories: *857 - repository: *832 + organization: *833 + repositories: *859 + repository: *834 requester: type: - 'null' @@ -144038,10 +144229,10 @@ webhooks: type: string enum: - added - enterprise: *829 + enterprise: *831 installation: *20 - organization: *831 - repositories_added: &858 + organization: *833 + repositories_added: &860 description: An array of repository objects, which were added to the installation. type: array @@ -144087,15 +144278,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *832 - repository_selection: &859 + repository: *834 + repository_selection: &861 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *856 + requester: *858 sender: *4 required: - action @@ -144174,10 +144365,10 @@ webhooks: type: string enum: - removed - enterprise: *829 + enterprise: *831 installation: *20 - organization: *831 - repositories_added: *858 + organization: *833 + repositories_added: *860 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -144204,9 +144395,9 @@ webhooks: - name - full_name - private - repository: *832 - repository_selection: *859 - requester: *856 + repository: *834 + repository_selection: *861 + requester: *858 sender: *4 required: - action @@ -144285,11 +144476,11 @@ webhooks: type: string enum: - suspend - enterprise: *829 + enterprise: *831 installation: *20 - organization: *831 - repositories: *857 - repository: *832 + organization: *833 + repositories: *859 + repository: *834 requester: type: - 'null' @@ -144472,10 +144663,10 @@ webhooks: type: string required: - from - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 target_type: type: string @@ -144554,11 +144745,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *829 + enterprise: *831 installation: *20 - organization: *831 - repositories: *857 - repository: *832 + organization: *833 + repositories: *859 + repository: *834 requester: type: - 'null' @@ -144806,8 +144997,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -145624,8 +145815,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145642,7 +145833,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -145986,8 +146177,8 @@ webhooks: - state - locked - assignee - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -146067,7 +146258,7 @@ webhooks: type: string enum: - deleted - comment: &860 + comment: &862 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -146234,8 +146425,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -147048,8 +147239,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147066,7 +147257,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -147412,8 +147603,8 @@ webhooks: - state - locked - assignee - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -147493,7 +147684,7 @@ webhooks: type: string enum: - edited - changes: &884 + changes: &886 description: The changes to the comment. type: object properties: @@ -147505,9 +147696,9 @@ webhooks: type: string required: - from - comment: *860 - enterprise: *829 - installation: *830 + comment: *862 + enterprise: *831 + installation: *832 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -148323,8 +148514,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148341,7 +148532,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -148685,8 +148876,8 @@ webhooks: - state - locked - assignee - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -148770,15 +148961,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *218 + blocked_issue: *219 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *218 + blocking_issue: *219 blocking_issue_repo: *72 - installation: *830 - organization: *831 - repository: *832 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -148866,15 +149057,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *218 + blocked_issue: *219 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *218 + blocking_issue: *219 blocking_issue_repo: *72 - installation: *830 - organization: *831 - repository: *832 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -148961,15 +149152,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *218 + blocked_issue: *219 blocked_issue_repo: *72 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *218 - installation: *830 - organization: *831 - repository: *832 + blocking_issue: *219 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -149057,15 +149248,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *218 + blocked_issue: *219 blocked_issue_repo: *72 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *218 - installation: *830 - organization: *831 - repository: *832 + blocking_issue: *219 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -149150,10 +149341,10 @@ webhooks: type: string enum: - assigned - assignee: *856 - enterprise: *829 - installation: *830 - issue: &863 + assignee: *858 + enterprise: *831 + installation: *832 + issue: &865 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -149965,11 +150156,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149986,7 +150177,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -150089,8 +150280,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -150170,8 +150361,8 @@ webhooks: type: string enum: - closed - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -150988,11 +151179,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151009,7 +151200,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -151255,8 +151446,8 @@ webhooks: required: - state - closed_at - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -151335,8 +151526,8 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -152144,11 +152335,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152165,7 +152356,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -152267,8 +152458,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -152347,8 +152538,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -153179,11 +153370,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153200,7 +153391,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -153281,7 +153472,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &861 + milestone: &863 title: Milestone description: A collection of related issues and pull requests. type: object @@ -153424,8 +153615,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -153524,8 +153715,8 @@ webhooks: type: string required: - from - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -154337,11 +154528,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154355,7 +154546,7 @@ webhooks: timeline_url: type: string format: uri - type: *351 + type: *355 title: description: Title of the issue type: string @@ -154461,9 +154652,9 @@ webhooks: - active_lock_reason - body - reactions - label: *855 - organization: *831 - repository: *832 + label: *857 + organization: *833 + repository: *834 sender: *4 required: - action @@ -154543,8 +154734,8 @@ webhooks: type: string enum: - labeled - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -155355,11 +155546,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155373,7 +155564,7 @@ webhooks: timeline_url: type: string format: uri - type: *351 + type: *355 title: description: Title of the issue type: string @@ -155479,9 +155670,9 @@ webhooks: - active_lock_reason - body - reactions - label: *855 - organization: *831 - repository: *832 + label: *857 + organization: *833 + repository: *834 sender: *4 required: - action @@ -155561,8 +155752,8 @@ webhooks: type: string enum: - locked - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -156398,11 +156589,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156416,7 +156607,7 @@ webhooks: timeline_url: type: string format: uri - type: *351 + type: *355 title: description: Title of the issue type: string @@ -156499,8 +156690,8 @@ webhooks: format: uri user_view_type: type: string - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -156579,8 +156770,8 @@ webhooks: type: string enum: - milestoned - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -157410,11 +157601,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157431,7 +157622,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -157511,9 +157702,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *861 - organization: *831 - repository: *832 + milestone: *863 + organization: *833 + repository: *834 sender: *4 required: - action @@ -158405,11 +158596,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -158505,7 +158696,7 @@ webhooks: required: - login - id - type: *351 + type: *355 required: - id - number @@ -158986,8 +159177,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -159799,11 +159990,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159820,7 +160011,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -159922,8 +160113,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -160003,9 +160194,9 @@ webhooks: type: string enum: - pinned - enterprise: *829 - installation: *830 - issue: &862 + enterprise: *831 + installation: *832 + issue: &864 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -160811,11 +161002,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -160832,7 +161023,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -160934,8 +161125,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -161014,8 +161205,8 @@ webhooks: type: string enum: - reopened - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -161849,11 +162040,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -161950,9 +162141,9 @@ webhooks: format: uri user_view_type: type: string - type: *351 - organization: *831 - repository: *832 + type: *355 + organization: *833 + repository: *834 sender: *4 required: - action @@ -162841,11 +163032,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -162862,7 +163053,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -163444,11 +163635,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *829 - installation: *830 - issue: *862 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + issue: *864 + organization: *833 + repository: *834 sender: *4 required: - action @@ -163528,12 +163719,12 @@ webhooks: type: string enum: - typed - enterprise: *829 - installation: *830 - issue: *863 - type: *351 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + issue: *865 + type: *355 + organization: *833 + repository: *834 sender: *4 required: - action @@ -163614,7 +163805,7 @@ webhooks: type: string enum: - unassigned - assignee: &887 + assignee: &889 title: User type: - object @@ -163686,11 +163877,11 @@ webhooks: required: - login - id - enterprise: *829 - installation: *830 - issue: *863 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + issue: *865 + organization: *833 + repository: *834 sender: *4 required: - action @@ -163769,12 +163960,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *829 - installation: *830 - issue: *863 - label: *855 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + issue: *865 + label: *857 + organization: *833 + repository: *834 sender: *4 required: - action @@ -163854,8 +164045,8 @@ webhooks: type: string enum: - unlocked - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -164689,11 +164880,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *773 - issue_dependencies_summary: *774 + sub_issues_summary: *775 + issue_dependencies_summary: *776 issue_field_values: type: array - items: *775 + items: *777 state: description: State of the issue; either 'open' or 'closed' type: string @@ -164710,7 +164901,7 @@ webhooks: title: description: Title of the issue type: string - type: *351 + type: *355 updated_at: type: string format: date-time @@ -164790,8 +164981,8 @@ webhooks: format: uri user_view_type: type: string - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -164871,11 +165062,11 @@ webhooks: type: string enum: - unpinned - enterprise: *829 - installation: *830 - issue: *862 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + issue: *864 + organization: *833 + repository: *834 sender: *4 required: - action @@ -164954,12 +165145,12 @@ webhooks: type: string enum: - untyped - enterprise: *829 - installation: *830 - issue: *863 - type: *351 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + issue: *865 + type: *355 + organization: *833 + repository: *834 sender: *4 required: - action @@ -165039,11 +165230,11 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - label: *855 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + label: *857 + organization: *833 + repository: *834 sender: *4 required: - action @@ -165121,11 +165312,11 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - label: *855 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + label: *857 + organization: *833 + repository: *834 sender: *4 required: - action @@ -165235,11 +165426,11 @@ webhooks: type: string required: - from - enterprise: *829 - installation: *830 - label: *855 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + label: *857 + organization: *833 + repository: *834 sender: *4 required: - action @@ -165321,9 +165512,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *829 - installation: *830 - marketplace_purchase: &864 + enterprise: *831 + installation: *832 + marketplace_purchase: &866 title: Marketplace Purchase type: object required: @@ -165411,8 +165602,8 @@ webhooks: type: integer unit_count: type: integer - organization: *831 - previous_marketplace_purchase: &865 + organization: *833 + previous_marketplace_purchase: &867 title: Marketplace Purchase type: object properties: @@ -165496,7 +165687,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *832 + repository: *834 sender: *4 required: - action @@ -165576,10 +165767,10 @@ webhooks: - changed effective_date: type: string - enterprise: *829 - installation: *830 - marketplace_purchase: *864 - organization: *831 + enterprise: *831 + installation: *832 + marketplace_purchase: *866 + organization: *833 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -165667,7 +165858,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *832 + repository: *834 sender: *4 required: - action @@ -165749,10 +165940,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *829 - installation: *830 - marketplace_purchase: *864 - organization: *831 + enterprise: *831 + installation: *832 + marketplace_purchase: *866 + organization: *833 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -165838,7 +166029,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *832 + repository: *834 sender: *4 required: - action @@ -165919,8 +166110,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 marketplace_purchase: title: Marketplace Purchase type: object @@ -166006,9 +166197,9 @@ webhooks: type: integer unit_count: type: integer - organization: *831 - previous_marketplace_purchase: *865 - repository: *832 + organization: *833 + previous_marketplace_purchase: *867 + repository: *834 sender: *4 required: - action @@ -166088,12 +166279,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *829 - installation: *830 - marketplace_purchase: *864 - organization: *831 - previous_marketplace_purchase: *865 - repository: *832 + enterprise: *831 + installation: *832 + marketplace_purchase: *866 + organization: *833 + previous_marketplace_purchase: *867 + repository: *834 sender: *4 required: - action @@ -166195,11 +166386,11 @@ webhooks: type: string required: - to - enterprise: *829 - installation: *830 - member: *856 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + member: *858 + organization: *833 + repository: *834 sender: *4 required: - action @@ -166301,11 +166492,11 @@ webhooks: type: - string - 'null' - enterprise: *829 - installation: *830 - member: *856 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + member: *858 + organization: *833 + repository: *834 sender: *4 required: - action @@ -166384,11 +166575,11 @@ webhooks: type: string enum: - removed - enterprise: *829 - installation: *830 - member: *856 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + member: *858 + organization: *833 + repository: *834 sender: *4 required: - action @@ -166466,11 +166657,11 @@ webhooks: type: string enum: - added - enterprise: *829 - installation: *830 - member: *856 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + member: *858 + organization: *833 + repository: *834 scope: description: The scope of the membership. Currently, can only be `team`. @@ -166548,7 +166739,7 @@ webhooks: required: - login - id - team: &866 + team: &868 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -166778,11 +166969,11 @@ webhooks: type: string enum: - removed - enterprise: *829 - installation: *830 - member: *856 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + member: *858 + organization: *833 + repository: *834 scope: description: The scope of the membership. Currently, can only be `team`. @@ -166861,7 +167052,7 @@ webhooks: required: - login - id - team: *866 + team: *868 required: - action - scope @@ -166943,8 +167134,8 @@ webhooks: type: string enum: - checks_requested - installation: *830 - merge_group: &867 + installation: *832 + merge_group: &869 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -166963,15 +167154,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *522 + head_commit: *523 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -167057,10 +167248,10 @@ webhooks: - merged - invalidated - dequeued - installation: *830 - merge_group: *867 - organization: *831 - repository: *832 + installation: *832 + merge_group: *869 + organization: *833 + repository: *834 sender: *4 required: - action @@ -167133,7 +167324,7 @@ webhooks: type: string enum: - deleted - enterprise: *829 + enterprise: *831 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -167242,12 +167433,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *830 - organization: *831 + installation: *832 + organization: *833 repository: anyOf: - type: 'null' - - *832 + - *834 sender: *4 required: - action @@ -167327,11 +167518,11 @@ webhooks: type: string enum: - closed - enterprise: *829 - installation: *830 - milestone: *861 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + milestone: *863 + organization: *833 + repository: *834 sender: *4 required: - action @@ -167410,9 +167601,9 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - milestone: &868 + enterprise: *831 + installation: *832 + milestone: &870 title: Milestone description: A collection of related issues and pull requests. type: object @@ -167554,8 +167745,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -167634,11 +167825,11 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - milestone: *861 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + milestone: *863 + organization: *833 + repository: *834 sender: *4 required: - action @@ -167748,11 +167939,11 @@ webhooks: type: string required: - from - enterprise: *829 - installation: *830 - milestone: *861 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + milestone: *863 + organization: *833 + repository: *834 sender: *4 required: - action @@ -167832,11 +168023,11 @@ webhooks: type: string enum: - opened - enterprise: *829 - installation: *830 - milestone: *868 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + milestone: *870 + organization: *833 + repository: *834 sender: *4 required: - action @@ -167915,11 +168106,11 @@ webhooks: type: string enum: - blocked - blocked_user: *856 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + blocked_user: *858 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -167998,11 +168189,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *856 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + blocked_user: *858 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -168078,7 +168269,7 @@ webhooks: enum: - created definition: *140 - enterprise: *829 + enterprise: *831 sender: *4 required: - action @@ -168158,8 +168349,8 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 sender: *4 required: - action @@ -168232,8 +168423,8 @@ webhooks: enum: - updated definition: *140 - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 sender: *4 required: - action @@ -168305,9 +168496,9 @@ webhooks: type: string enum: - updated - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 sender: *4 new_property_values: type: array @@ -168395,9 +168586,9 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - membership: &869 + enterprise: *831 + installation: *832 + membership: &871 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -168507,8 +168698,8 @@ webhooks: - role - organization_url - user - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -168586,11 +168777,11 @@ webhooks: type: string enum: - member_added - enterprise: *829 - installation: *830 - membership: *869 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + membership: *871 + organization: *833 + repository: *834 sender: *4 required: - action @@ -168669,8 +168860,8 @@ webhooks: type: string enum: - member_invited - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -168792,10 +168983,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 - user: *856 + user: *858 required: - action - invitation @@ -168873,11 +169064,11 @@ webhooks: type: string enum: - member_removed - enterprise: *829 - installation: *830 - membership: *869 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + membership: *871 + organization: *833 + repository: *834 sender: *4 required: - action @@ -168964,11 +169155,11 @@ webhooks: properties: from: type: string - enterprise: *829 - installation: *830 - membership: *869 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + membership: *871 + organization: *833 + repository: *834 sender: *4 required: - action @@ -169044,9 +169235,9 @@ webhooks: type: string enum: - published - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 package: description: Information about the package. type: object @@ -169569,7 +169760,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &870 + items: &872 title: Ruby Gems metadata type: object properties: @@ -169666,7 +169857,7 @@ webhooks: - owner - package_version - registry - repository: *832 + repository: *834 sender: *4 required: - action @@ -169742,9 +169933,9 @@ webhooks: type: string enum: - updated - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 package: description: Information about the package. type: object @@ -170106,7 +170297,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *870 + items: *872 source_url: type: string format: uri @@ -170177,7 +170368,7 @@ webhooks: - owner - package_version - registry - repository: *832 + repository: *834 sender: *4 required: - action @@ -170358,12 +170549,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *829 + enterprise: *831 id: type: integer - installation: *830 - organization: *831 - repository: *832 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - id @@ -170440,7 +170631,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &871 + personal_access_token_request: &873 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -170590,10 +170781,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *829 - organization: *831 + enterprise: *831 + organization: *833 sender: *4 - installation: *830 + installation: *832 required: - action - personal_access_token_request @@ -170670,11 +170861,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *871 - enterprise: *829 - organization: *831 + personal_access_token_request: *873 + enterprise: *831 + organization: *833 sender: *4 - installation: *830 + installation: *832 required: - action - personal_access_token_request @@ -170750,11 +170941,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *871 - enterprise: *829 - organization: *831 + personal_access_token_request: *873 + enterprise: *831 + organization: *833 sender: *4 - installation: *830 + installation: *832 required: - action - personal_access_token_request @@ -170829,11 +171020,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *871 - organization: *831 - enterprise: *829 + personal_access_token_request: *873 + organization: *833 + enterprise: *831 sender: *4 - installation: *830 + installation: *832 required: - action - personal_access_token_request @@ -170938,7 +171129,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *872 + last_response: *874 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -170970,8 +171161,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 zen: description: Random string of GitHub zen. @@ -171216,10 +171407,10 @@ webhooks: - from required: - note - enterprise: *829 - installation: *830 - organization: *831 - project_card: &873 + enterprise: *831 + installation: *832 + organization: *833 + project_card: &875 title: Project Card type: object properties: @@ -171342,7 +171533,7 @@ webhooks: - creator - created_at - updated_at - repository: *832 + repository: *834 sender: *4 required: - action @@ -171423,11 +171614,11 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - project_card: *873 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + project_card: *875 + repository: *834 sender: *4 required: - action @@ -171507,9 +171698,9 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 project_card: title: Project Card type: object @@ -171639,7 +171830,7 @@ webhooks: repository: anyOf: - type: 'null' - - *832 + - *834 sender: *4 required: - action @@ -171733,11 +171924,11 @@ webhooks: - from required: - note - enterprise: *829 - installation: *830 - organization: *831 - project_card: *873 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + project_card: *875 + repository: *834 sender: *4 required: - action @@ -171831,9 +172022,9 @@ webhooks: - from required: - column_id - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 project_card: allOf: - title: Project Card @@ -172030,7 +172221,7 @@ webhooks: type: string required: - after_id - repository: *832 + repository: *834 sender: *4 required: - action @@ -172110,10 +172301,10 @@ webhooks: type: string enum: - closed - enterprise: *829 - installation: *830 - organization: *831 - project: &875 + enterprise: *831 + installation: *832 + organization: *833 + project: &877 title: Project type: object properties: @@ -172240,7 +172431,7 @@ webhooks: - creator - created_at - updated_at - repository: *832 + repository: *834 sender: *4 required: - action @@ -172320,10 +172511,10 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - project_column: &874 + enterprise: *831 + installation: *832 + organization: *833 + project_column: &876 title: Project Column type: object properties: @@ -172363,7 +172554,7 @@ webhooks: - name - created_at - updated_at - repository: *832 + repository: *834 sender: *4 required: - action @@ -172442,14 +172633,14 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - organization: *831 - project_column: *874 + enterprise: *831 + installation: *832 + organization: *833 + project_column: *876 repository: anyOf: - type: 'null' - - *832 + - *834 sender: *4 required: - action @@ -172538,11 +172729,11 @@ webhooks: type: string required: - from - enterprise: *829 - installation: *830 - organization: *831 - project_column: *874 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + project_column: *876 + repository: *834 sender: *4 required: - action @@ -172622,11 +172813,11 @@ webhooks: type: string enum: - moved - enterprise: *829 - installation: *830 - organization: *831 - project_column: *874 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + project_column: *876 + repository: *834 sender: *4 required: - action @@ -172706,11 +172897,11 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - project: *875 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + project: *877 + repository: *834 sender: *4 required: - action @@ -172790,14 +172981,14 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - organization: *831 - project: *875 + enterprise: *831 + installation: *832 + organization: *833 + project: *877 repository: anyOf: - type: 'null' - - *832 + - *834 sender: *4 required: - action @@ -172898,11 +173089,11 @@ webhooks: type: string required: - from - enterprise: *829 - installation: *830 - organization: *831 - project: *875 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + project: *877 + repository: *834 sender: *4 required: - action @@ -172981,11 +173172,11 @@ webhooks: type: string enum: - reopened - enterprise: *829 - installation: *830 - organization: *831 - project: *875 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + project: *877 + repository: *834 sender: *4 required: - action @@ -173066,9 +173257,9 @@ webhooks: type: string enum: - closed - installation: *830 - organization: *831 - projects_v2: *383 + installation: *832 + organization: *833 + projects_v2: *386 sender: *4 required: - action @@ -173149,9 +173340,9 @@ webhooks: type: string enum: - created - installation: *830 - organization: *831 - projects_v2: *383 + installation: *832 + organization: *833 + projects_v2: *386 sender: *4 required: - action @@ -173232,9 +173423,9 @@ webhooks: type: string enum: - deleted - installation: *830 - organization: *831 - projects_v2: *383 + installation: *832 + organization: *833 + projects_v2: *386 sender: *4 required: - action @@ -173355,9 +173546,9 @@ webhooks: type: string to: type: string - installation: *830 - organization: *831 - projects_v2: *383 + installation: *832 + organization: *833 + projects_v2: *386 sender: *4 required: - action @@ -173440,7 +173631,7 @@ webhooks: type: string enum: - archived - changes: &879 + changes: &881 type: object properties: archived_at: @@ -173456,9 +173647,9 @@ webhooks: - string - 'null' format: date-time - installation: *830 - organization: *831 - projects_v2_item: &876 + installation: *832 + organization: *833 + projects_v2_item: &878 title: Projects v2 Item description: An item belonging to a project type: object @@ -173476,7 +173667,7 @@ webhooks: type: string description: The node ID of the content represented by this item. - content_type: *389 + content_type: *392 creator: *4 created_at: type: string @@ -173598,9 +173789,9 @@ webhooks: - 'null' to: type: string - installation: *830 - organization: *831 - projects_v2_item: *876 + installation: *832 + organization: *833 + projects_v2_item: *878 sender: *4 required: - action @@ -173682,9 +173873,9 @@ webhooks: type: string enum: - created - installation: *830 - organization: *831 - projects_v2_item: *876 + installation: *832 + organization: *833 + projects_v2_item: *878 sender: *4 required: - action @@ -173765,9 +173956,9 @@ webhooks: type: string enum: - deleted - installation: *830 - organization: *831 - projects_v2_item: *876 + installation: *832 + organization: *833 + projects_v2_item: *878 sender: *4 required: - action @@ -173872,7 +174063,7 @@ webhooks: oneOf: - type: string - type: integer - - &877 + - &879 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -173896,7 +174087,7 @@ webhooks: required: - id - name - - &878 + - &880 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -173936,8 +174127,8 @@ webhooks: oneOf: - type: string - type: integer - - *877 - - *878 + - *879 + - *880 type: - 'null' - string @@ -173960,9 +174151,9 @@ webhooks: - 'null' required: - body - installation: *830 - organization: *831 - projects_v2_item: *876 + installation: *832 + organization: *833 + projects_v2_item: *878 sender: *4 required: - action @@ -174059,9 +174250,9 @@ webhooks: type: - string - 'null' - installation: *830 - organization: *831 - projects_v2_item: *876 + installation: *832 + organization: *833 + projects_v2_item: *878 sender: *4 required: - action @@ -174144,10 +174335,10 @@ webhooks: type: string enum: - restored - changes: *879 - installation: *830 - organization: *831 - projects_v2_item: *876 + changes: *881 + installation: *832 + organization: *833 + projects_v2_item: *878 sender: *4 required: - action @@ -174229,9 +174420,9 @@ webhooks: type: string enum: - reopened - installation: *830 - organization: *831 - projects_v2: *383 + installation: *832 + organization: *833 + projects_v2: *386 sender: *4 required: - action @@ -174312,9 +174503,9 @@ webhooks: type: string enum: - created - installation: *830 - organization: *831 - projects_v2_status_update: *880 + installation: *832 + organization: *833 + projects_v2_status_update: *882 sender: *4 required: - action @@ -174395,9 +174586,9 @@ webhooks: type: string enum: - deleted - installation: *830 - organization: *831 - projects_v2_status_update: *880 + installation: *832 + organization: *833 + projects_v2_status_update: *882 sender: *4 required: - action @@ -174543,9 +174734,9 @@ webhooks: - string - 'null' format: date - installation: *830 - organization: *831 - projects_v2_status_update: *880 + installation: *832 + organization: *833 + projects_v2_status_update: *882 sender: *4 required: - action @@ -174616,10 +174807,10 @@ webhooks: title: public event type: object properties: - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - repository @@ -174696,13 +174887,13 @@ webhooks: type: string enum: - assigned - assignee: *856 - enterprise: *829 - installation: *830 - number: &881 + assignee: *858 + enterprise: *831 + installation: *832 + number: &883 description: The pull request number. type: integer - organization: *831 + organization: *833 pull_request: title: Pull Request type: object @@ -177051,7 +177242,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 sender: *4 required: - action @@ -177133,11 +177324,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 number: type: integer - organization: *831 + organization: *833 pull_request: title: Pull Request type: object @@ -179479,7 +179670,7 @@ webhooks: - draft reason: type: string - repository: *832 + repository: *834 sender: *4 required: - action @@ -179561,11 +179752,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 number: type: integer - organization: *831 + organization: *833 pull_request: title: Pull Request type: object @@ -181907,7 +182098,7 @@ webhooks: - draft reason: type: string - repository: *832 + repository: *834 sender: *4 required: - action @@ -181989,13 +182180,13 @@ webhooks: type: string enum: - closed - enterprise: *829 - installation: *830 - number: *881 - organization: *831 - pull_request: &882 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 + pull_request: &884 allOf: - - *680 + - *682 - type: object properties: allow_auto_merge: @@ -182057,7 +182248,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *832 + repository: *834 sender: *4 required: - action @@ -182138,12 +182329,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *829 - installation: *830 - number: *881 - organization: *831 - pull_request: *882 - repository: *832 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 + pull_request: *884 + repository: *834 sender: *4 required: - action @@ -182223,11 +182414,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *829 - milestone: *387 - number: *881 - organization: *831 - pull_request: &883 + enterprise: *831 + milestone: *390 + number: *883 + organization: *833 + pull_request: &885 title: Pull Request type: object properties: @@ -184554,7 +184745,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 sender: *4 required: - action @@ -184633,11 +184824,11 @@ webhooks: type: string enum: - dequeued - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 number: type: integer - organization: *831 + organization: *833 pull_request: title: Pull Request type: object @@ -186983,7 +187174,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *832 + repository: *834 sender: *4 required: - action @@ -187107,12 +187298,12 @@ webhooks: type: string required: - from - enterprise: *829 - installation: *830 - number: *881 - organization: *831 - pull_request: *882 - repository: *832 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 + pull_request: *884 + repository: *834 sender: *4 required: - action @@ -187192,11 +187383,11 @@ webhooks: type: string enum: - enqueued - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 number: type: integer - organization: *831 + organization: *833 pull_request: title: Pull Request type: object @@ -189527,7 +189718,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 sender: *4 required: - action @@ -189607,11 +189798,11 @@ webhooks: type: string enum: - labeled - enterprise: *829 - installation: *830 - label: *855 - number: *881 - organization: *831 + enterprise: *831 + installation: *832 + label: *857 + number: *883 + organization: *833 pull_request: title: Pull Request type: object @@ -191959,7 +192150,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 sender: *4 required: - action @@ -192040,10 +192231,10 @@ webhooks: type: string enum: - locked - enterprise: *829 - installation: *830 - number: *881 - organization: *831 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 pull_request: title: Pull Request type: object @@ -194389,7 +194580,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 sender: *4 required: - action @@ -194469,12 +194660,12 @@ webhooks: type: string enum: - milestoned - enterprise: *829 - milestone: *387 - number: *881 - organization: *831 - pull_request: *883 - repository: *832 + enterprise: *831 + milestone: *390 + number: *883 + organization: *833 + pull_request: *885 + repository: *834 sender: *4 required: - action @@ -194553,12 +194744,12 @@ webhooks: type: string enum: - opened - enterprise: *829 - installation: *830 - number: *881 - organization: *831 - pull_request: *882 - repository: *832 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 + pull_request: *884 + repository: *834 sender: *4 required: - action @@ -194639,12 +194830,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *829 - installation: *830 - number: *881 - organization: *831 - pull_request: *882 - repository: *832 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 + pull_request: *884 + repository: *834 sender: *4 required: - action @@ -194724,12 +194915,12 @@ webhooks: type: string enum: - reopened - enterprise: *829 - installation: *830 - number: *881 - organization: *831 - pull_request: *882 - repository: *832 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 + pull_request: *884 + repository: *834 sender: *4 required: - action @@ -195104,9 +195295,9 @@ webhooks: - start_side - side - reactions - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 pull_request: type: object properties: @@ -197336,7 +197527,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *832 + repository: *834 sender: *4 required: - action @@ -197416,7 +197607,7 @@ webhooks: type: string enum: - deleted - comment: &885 + comment: &887 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. @@ -197709,9 +197900,9 @@ webhooks: - start_side - side - reactions - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 pull_request: type: object properties: @@ -199929,7 +200120,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *832 + repository: *834 sender: *4 required: - action @@ -200009,11 +200200,11 @@ webhooks: type: string enum: - edited - changes: *884 - comment: *885 - enterprise: *829 - installation: *830 - organization: *831 + changes: *886 + comment: *887 + enterprise: *831 + installation: *832 + organization: *833 pull_request: type: object properties: @@ -202234,7 +202425,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *832 + repository: *834 sender: *4 required: - action @@ -202315,9 +202506,9 @@ webhooks: type: string enum: - dismissed - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 pull_request: title: Simple Pull Request type: object @@ -204550,7 +204741,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *832 + repository: *834 review: description: The review that was affected. type: object @@ -204801,9 +204992,9 @@ webhooks: type: string required: - from - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 pull_request: title: Simple Pull Request type: object @@ -206917,8 +207108,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *832 - review: &886 + repository: *834 + review: &888 description: The review that was affected. type: object properties: @@ -207156,12 +207347,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 number: description: The pull request number. type: integer - organization: *831 + organization: *833 pull_request: title: Pull Request type: object @@ -209508,7 +209699,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 requested_reviewer: title: User type: @@ -209594,12 +209785,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 number: description: The pull request number. type: integer - organization: *831 + organization: *833 pull_request: title: Pull Request type: object @@ -211953,7 +212144,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 requested_team: title: Team description: Groups of organization members that gives permissions @@ -212148,12 +212339,12 @@ webhooks: type: string enum: - review_requested - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 number: description: The pull request number. type: integer - organization: *831 + organization: *833 pull_request: title: Pull Request type: object @@ -214502,7 +214693,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 requested_reviewer: title: User type: @@ -214589,12 +214780,12 @@ webhooks: type: string enum: - review_requested - enterprise: *829 - installation: *830 + enterprise: *831 + installation: *832 number: description: The pull request number. type: integer - organization: *831 + organization: *833 pull_request: title: Pull Request type: object @@ -216934,7 +217125,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 requested_team: title: Team description: Groups of organization members that gives permissions @@ -217118,9 +217309,9 @@ webhooks: type: string enum: - submitted - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 pull_request: title: Simple Pull Request type: object @@ -219356,8 +219547,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *832 - review: *886 + repository: *834 + review: *888 sender: *4 required: - action @@ -219437,9 +219628,9 @@ webhooks: type: string enum: - resolved - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 pull_request: title: Simple Pull Request type: object @@ -221570,7 +221761,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *832 + repository: *834 sender: *4 thread: type: object @@ -221967,9 +222158,9 @@ webhooks: type: string enum: - unresolved - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 pull_request: title: Simple Pull Request type: object @@ -224083,7 +224274,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *832 + repository: *834 sender: *4 thread: type: object @@ -224482,10 +224673,10 @@ webhooks: type: string before: type: string - enterprise: *829 - installation: *830 - number: *881 - organization: *831 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 pull_request: title: Pull Request type: object @@ -226820,7 +227011,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 sender: *4 required: - action @@ -226902,11 +227093,11 @@ webhooks: type: string enum: - unassigned - assignee: *887 - enterprise: *829 - installation: *830 - number: *881 - organization: *831 + assignee: *889 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 pull_request: title: Pull Request type: object @@ -229256,7 +229447,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 sender: *4 required: - action @@ -229335,11 +229526,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *829 - installation: *830 - label: *855 - number: *881 - organization: *831 + enterprise: *831 + installation: *832 + label: *857 + number: *883 + organization: *833 pull_request: title: Pull Request type: object @@ -231678,7 +231869,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 sender: *4 required: - action @@ -231759,10 +231950,10 @@ webhooks: type: string enum: - unlocked - enterprise: *829 - installation: *830 - number: *881 - organization: *831 + enterprise: *831 + installation: *832 + number: *883 + organization: *833 pull_request: title: Pull Request type: object @@ -234091,7 +234282,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *832 + repository: *834 sender: *4 required: - action @@ -234294,7 +234485,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *829 + enterprise: *831 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -234389,8 +234580,8 @@ webhooks: - url - author - committer - installation: *830 - organization: *831 + installation: *832 + organization: *833 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -234978,9 +235169,9 @@ webhooks: type: string enum: - published - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 registry_package: type: object properties: @@ -235457,7 +235648,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *870 + items: *872 summary: type: string tag_name: @@ -235513,7 +235704,7 @@ webhooks: - owner - package_version - registry - repository: *832 + repository: *834 sender: *4 required: - action @@ -235591,9 +235782,9 @@ webhooks: type: string enum: - updated - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 registry_package: type: object properties: @@ -235905,7 +236096,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *870 + items: *872 summary: type: string tag_name: @@ -235955,7 +236146,7 @@ webhooks: - owner - package_version - registry - repository: *832 + repository: *834 sender: *4 required: - action @@ -236032,10 +236223,10 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - release: &888 + enterprise: *831 + installation: *832 + organization: *833 + release: &890 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -236366,7 +236557,7 @@ webhooks: - updated_at - zipball_url - body - repository: *832 + repository: *834 sender: *4 required: - action @@ -236443,11 +236634,11 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - organization: *831 - release: *888 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + release: *890 + repository: *834 sender: *4 required: - action @@ -236564,11 +236755,11 @@ webhooks: type: boolean required: - to - enterprise: *829 - installation: *830 - organization: *831 - release: *888 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + release: *890 + repository: *834 sender: *4 required: - action @@ -236646,9 +236837,9 @@ webhooks: type: string enum: - prereleased - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -236984,7 +237175,7 @@ webhooks: - string - 'null' format: uri - repository: *832 + repository: *834 sender: *4 required: - action @@ -237060,10 +237251,10 @@ webhooks: type: string enum: - published - enterprise: *829 - installation: *830 - organization: *831 - release: &889 + enterprise: *831 + installation: *832 + organization: *833 + release: &891 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -237396,7 +237587,7 @@ webhooks: - string - 'null' format: uri - repository: *832 + repository: *834 sender: *4 required: - action @@ -237472,11 +237663,11 @@ webhooks: type: string enum: - released - enterprise: *829 - installation: *830 - organization: *831 - release: *888 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + release: *890 + repository: *834 sender: *4 required: - action @@ -237552,11 +237743,11 @@ webhooks: type: string enum: - unpublished - enterprise: *829 - installation: *830 - organization: *831 - release: *889 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + release: *891 + repository: *834 sender: *4 required: - action @@ -237632,11 +237823,11 @@ webhooks: type: string enum: - published - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - repository_advisory: *733 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + repository_advisory: *735 sender: *4 required: - action @@ -237712,11 +237903,11 @@ webhooks: type: string enum: - reported - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - repository_advisory: *733 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + repository_advisory: *735 sender: *4 required: - action @@ -237792,10 +237983,10 @@ webhooks: type: string enum: - archived - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -237872,10 +238063,10 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -237953,10 +238144,10 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -238041,10 +238232,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -238159,10 +238350,10 @@ webhooks: - 'null' items: type: string - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -238234,10 +238425,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 status: type: string @@ -238318,10 +238509,10 @@ webhooks: type: string enum: - privatized - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -238398,10 +238589,10 @@ webhooks: type: string enum: - publicized - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -238495,10 +238686,10 @@ webhooks: - name required: - repository - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -238578,10 +238769,10 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 repository_ruleset: *179 sender: *4 required: @@ -238660,10 +238851,10 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 repository_ruleset: *179 sender: *4 required: @@ -238742,10 +238933,10 @@ webhooks: type: string enum: - edited - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 repository_ruleset: *179 changes: type: object @@ -238807,16 +238998,16 @@ webhooks: properties: added: type: array - items: *701 + items: *703 deleted: type: array - items: *701 + items: *703 updated: type: array items: type: object properties: - rule: *701 + rule: *703 changes: type: object properties: @@ -239053,10 +239244,10 @@ webhooks: - from required: - owner - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -239134,10 +239325,10 @@ webhooks: type: string enum: - unarchived - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -239215,7 +239406,7 @@ webhooks: type: string enum: - create - alert: &890 + alert: &892 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -239339,10 +239530,10 @@ webhooks: type: string enum: - open - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -239552,10 +239743,10 @@ webhooks: type: string enum: - dismissed - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -239633,11 +239824,11 @@ webhooks: type: string enum: - reopen - alert: *890 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + alert: *892 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -239839,10 +240030,10 @@ webhooks: enum: - fixed - open - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -239920,7 +240111,7 @@ webhooks: type: string enum: - created - alert: &891 + alert: &893 type: object properties: number: *119 @@ -240034,10 +240225,10 @@ webhooks: anyOf: - type: 'null' - *4 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -240118,11 +240309,11 @@ webhooks: type: string enum: - created - alert: *891 - installation: *830 - location: *892 - organization: *831 - repository: *832 + alert: *893 + installation: *832 + location: *894 + organization: *833 + repository: *834 sender: *4 required: - location @@ -240360,11 +240551,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *891 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + alert: *893 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -240442,11 +240633,11 @@ webhooks: type: string enum: - reopened - alert: *891 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + alert: *893 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -240524,11 +240715,11 @@ webhooks: type: string enum: - resolved - alert: *891 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + alert: *893 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -240606,11 +240797,11 @@ webhooks: type: string enum: - validated - alert: *891 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + alert: *893 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -240740,10 +240931,10 @@ webhooks: - organization - enterprise - - repository: *832 - enterprise: *829 - installation: *830 - organization: *831 + repository: *834 + enterprise: *831 + installation: *832 + organization: *833 sender: *4 required: - action @@ -240821,11 +241012,11 @@ webhooks: type: string enum: - published - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - security_advisory: &893 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + security_advisory: &895 description: The details of the security advisory, including summary, description, and severity. type: object @@ -241011,11 +241202,11 @@ webhooks: type: string enum: - updated - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 - security_advisory: *893 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 + security_advisory: *895 sender: *4 required: - action @@ -241088,10 +241279,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -241277,11 +241468,11 @@ webhooks: from: type: object properties: - security_and_analysis: *395 - enterprise: *829 - installation: *830 - organization: *831 - repository: *461 + security_and_analysis: *398 + enterprise: *831 + installation: *832 + organization: *833 + repository: *462 sender: *4 required: - changes @@ -241359,12 +241550,12 @@ webhooks: type: string enum: - cancelled - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - sponsorship: &894 + sponsorship: &896 type: object properties: created_at: @@ -241669,12 +241860,12 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - sponsorship: *894 + sponsorship: *896 required: - action - sponsorship @@ -241762,12 +241953,12 @@ webhooks: type: string required: - from - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - sponsorship: *894 + sponsorship: *896 required: - action - changes @@ -241844,17 +242035,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &895 + effective_date: &897 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: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - sponsorship: *894 + sponsorship: *896 required: - action - sponsorship @@ -241928,7 +242119,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &896 + changes: &898 type: object properties: tier: @@ -241972,13 +242163,13 @@ webhooks: - from required: - tier - effective_date: *895 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + effective_date: *897 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - sponsorship: *894 + sponsorship: *896 required: - action - changes @@ -242055,13 +242246,13 @@ webhooks: type: string enum: - tier_changed - changes: *896 - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + changes: *898 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - sponsorship: *894 + sponsorship: *896 required: - action - changes @@ -242135,10 +242326,10 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -242222,10 +242413,10 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -242659,15 +242850,15 @@ webhooks: type: - string - 'null' - enterprise: *829 + enterprise: *831 id: description: The unique identifier of the status. type: integer - installation: *830 + installation: *832 name: type: string - organization: *831 - repository: *832 + organization: *833 + repository: *834 sender: *4 sha: description: The Commit SHA. @@ -242777,15 +242968,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *218 + parent_issue: *219 parent_issue_repo: *72 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *218 - installation: *830 - organization: *831 - repository: *832 + sub_issue: *219 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -242869,15 +243060,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *218 + parent_issue: *219 parent_issue_repo: *72 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *218 - installation: *830 - organization: *831 - repository: *832 + sub_issue: *219 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -242961,15 +243152,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *218 + sub_issue: *219 sub_issue_repo: *72 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *218 - installation: *830 - organization: *831 - repository: *832 + parent_issue: *219 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -243053,15 +243244,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *218 + sub_issue: *219 sub_issue_repo: *72 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *218 - installation: *830 - organization: *831 - repository: *832 + parent_issue: *219 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -243138,12 +243329,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - team: &897 + team: &899 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -243373,9 +243564,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 repository: title: Repository description: A git repository @@ -243845,7 +244036,7 @@ webhooks: - topics - visibility sender: *4 - team: *897 + team: *899 required: - action - team @@ -243921,9 +244112,9 @@ webhooks: type: string enum: - created - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 repository: title: Repository description: A git repository @@ -244393,7 +244584,7 @@ webhooks: - topics - visibility sender: *4 - team: *897 + team: *899 required: - action - team @@ -244470,9 +244661,9 @@ webhooks: type: string enum: - deleted - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 repository: title: Repository description: A git repository @@ -244942,7 +245133,7 @@ webhooks: - topics - visibility sender: *4 - team: *897 + team: *899 required: - action - team @@ -245086,9 +245277,9 @@ webhooks: - from required: - permissions - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 repository: title: Repository description: A git repository @@ -245558,7 +245749,7 @@ webhooks: - topics - visibility sender: *4 - team: *897 + team: *899 required: - action - changes @@ -245636,9 +245827,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *829 - installation: *830 - organization: *831 + enterprise: *831 + installation: *832 + organization: *833 repository: title: Repository description: A git repository @@ -246108,7 +246299,7 @@ webhooks: - topics - visibility sender: *4 - team: *897 + team: *899 required: - action - team @@ -246184,10 +246375,10 @@ webhooks: type: string enum: - started - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 required: - action @@ -246260,17 +246451,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *829 + enterprise: *831 inputs: type: - object - 'null' additionalProperties: true - installation: *830 - organization: *831 + installation: *832 + organization: *833 ref: type: string - repository: *832 + repository: *834 sender: *4 workflow: type: string @@ -246352,10 +246543,10 @@ webhooks: type: string enum: - completed - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 workflow_job: allOf: @@ -246611,7 +246802,7 @@ webhooks: type: string required: - conclusion - deployment: *588 + deployment: *589 required: - action - repository @@ -246690,10 +246881,10 @@ webhooks: type: string enum: - in_progress - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 workflow_job: allOf: @@ -246975,7 +247166,7 @@ webhooks: required: - status - steps - deployment: *588 + deployment: *589 required: - action - repository @@ -247054,10 +247245,10 @@ webhooks: type: string enum: - queued - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 workflow_job: type: object @@ -247203,7 +247394,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *588 + deployment: *589 required: - action - repository @@ -247282,10 +247473,10 @@ webhooks: type: string enum: - waiting - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 workflow_job: type: object @@ -247432,7 +247623,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *588 + deployment: *589 required: - action - repository @@ -247512,12 +247703,12 @@ webhooks: type: string enum: - completed - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - workflow: *851 + workflow: *853 workflow_run: title: Workflow Run type: object @@ -248536,12 +248727,12 @@ webhooks: type: string enum: - in_progress - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - workflow: *851 + workflow: *853 workflow_run: title: Workflow Run type: object @@ -249545,12 +249736,12 @@ webhooks: type: string enum: - requested - enterprise: *829 - installation: *830 - organization: *831 - repository: *832 + enterprise: *831 + installation: *832 + organization: *833 + repository: *834 sender: *4 - workflow: *851 + workflow: *853 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index 0efc46964..c4b10c898 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -11960,6 +11960,517 @@ } } }, + "/enterprises/{enterprise}/settings/billing/budgets": { + "get": { + "summary": "Get all budgets", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all budgets for an enterprise. The authenticated user must be an enterprise admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-all-budgets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-all-budgets" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/get_all_budgets" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "post": { + "summary": "Create a budget", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "tags": [ + "billing" + ], + "operationId": "billing/create-budget", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#create-a-budget" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "budget_amount", + "prevent_further_usage", + "budget_alerting", + "budget_scope", + "budget_type" + ], + "properties": { + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "required": [ + "will_alert", + "alert_recipients" + ], + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "default": "" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + }, + "examples": { + "create-budget": { + "summary": "Create budget example", + "value": { + "budget_amount": 200, + "prevent_further_usage": true, + "budget_scope": "enterprise", + "budget_entity_name": "", + "budget_type": "ProductPricing", + "budget_product_sku": "actions", + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Budget created successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/create-budget" + }, + "examples": { + "create-budget": { + "$ref": "#/components/examples/create-budget" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "description": "Feature not enabled", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#create-a-budget" + } + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to create budget.", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#create-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, + "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": { + "get": { + "summary": "Get a budget by ID", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a budget by ID. The authenticated user must be an enterprise admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-budget", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-a-budget-by-id" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/budget" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/budget" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "patch": { + "summary": "Update a budget", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nUpdates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "tags": [ + "billing" + ], + "operationId": "billing/update-budget", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#update-a-budget" + }, + "parameters": [ + { + "name": "enterprise", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The slug version of the enterprise name" + }, + { + "name": "budget_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the budget" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + }, + "examples": { + "update-budget": { + "summary": "Update budget example", + "value": { + "prevent_further_usage": false, + "budget_amount": 10, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Budget updated successfully", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/update-budget" + }, + "examples": { + "update-budget": { + "$ref": "#/components/examples/update-budget" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "description": "Budget not found or feature not enabled", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "budget-not-found": { + "value": { + "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget" + } + }, + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget" + } + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to retrieve budget.", + "documentation_url": "https://docs.github.com/rest/enterprise-admin/billing#update-a-budget" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to update budget.", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "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/enhanced-billing#delete-a-budget" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/budget" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/delete-budget" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, "/enterprises/{enterprise}/settings/billing/cost-centers": { "get": { "summary": "Get all cost centers for an enterprise", @@ -12747,7 +13258,7 @@ }, "/enterprises/{enterprise}/settings/billing/usage/summary": { "get": { - "summary": "Get billing usage summary report for an enterprise", + "summary": "Get billing usage summary for an enterprise", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default, this endpoint will return usage across all cost centers in the enterprise.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" @@ -12755,7 +13266,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-ghe", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-summary-report-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-summary-for-an-enterprise" }, "parameters": [ { @@ -17425,6 +17936,387 @@ } } }, + "/organizations/{org}/settings/billing/budgets": { + "get": { + "summary": "Get all budgets for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all budgets for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-all-budgets-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-all-budgets-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/get_all_budgets" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, + "/organizations/{org}/settings/billing/budgets/{budget_id}": { + "get": { + "summary": "Get a budget by ID for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a budget by ID. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-a-budget-by-id-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/budget" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/budget" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "patch": { + "summary": "Update a budget for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nUpdates an existing budget for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/update-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#update-a-budget-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/budget" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + }, + "examples": { + "update-budget": { + "summary": "Update budget example", + "value": { + "prevent_further_usage": false, + "budget_amount": 10, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Budget updated successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "examples": [ + "Budget successfully updated." + ] + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "required": [ + "will_alert", + "alert_recipients" + ], + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "default": "" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + } + } + }, + "examples": { + "update-budget": { + "value": { + "message": "Budget successfully updated.", + "id": "550e8400-e29b-41d4-a716-446655440000" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "description": "Budget not found or feature not enabled", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "budget-not-found": { + "value": { + "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget" + } + }, + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget" + } + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to update budget.", + "documentation_url": "https://docs.github.com/rest/billing/enhanced-billing#update-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "enhanced-billing" + } + }, + "delete": { + "summary": "Delete a budget for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/delete-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#delete-a-budget-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/budget" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/delete-budget" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + } + } + }, "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", @@ -17541,7 +18433,7 @@ }, "/organizations/{org}/settings/billing/usage/summary": { "get": { - "summary": "Get billing usage summary report for an organization", + "summary": "Get billing usage summary for an organization", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" @@ -17549,7 +18441,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-report-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-for-an-organization" }, "parameters": [ { @@ -34768,172 +35660,6 @@ } } }, - "/orgs/{org}/projects": { - "get": { - "summary": "List organization 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-organization-projects" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/project" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create an organization 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": [ - "projects-classic" - ], - "operationId": "projects-classic/create-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-an-organization-project" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the project." - }, - "body": { - "type": "string", - "description": "The description of the project." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year." - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-2" - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "410": { - "$ref": "#/components/responses/gone" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/orgs/{org}/projectsV2": { "get": { "summary": "List projects for organization", @@ -42428,269 +43154,6 @@ "deprecated": true } }, - "/projects/{project_id}": { - "get": { - "summary": "Get 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": [ - "projects-classic" - ], - "operationId": "projects-classic/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#get-a-project" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-3" - } - } - } - } - }, - "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": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update 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.", - "operationId": "projects-classic/update", - "tags": [ - "projects-classic" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#update-a-project" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone.", - "type": "boolean" - } - }, - "type": "object" - }, - "examples": { - "default": { - "summary": "Change the name, state, and permissions for a project", - "value": { - "name": "Week One Sprint", - "state": "open", - "organization_permission": "write" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-3" - } - } - } - } - }, - "404": { - "description": "Not Found if the authenticated user does not have access to the project" - }, - "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" - }, - "410": { - "$ref": "#/components/responses/gone" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete 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.", - "operationId": "projects-classic/delete", - "tags": [ - "projects-classic" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#delete-a-project" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - } - ], - "responses": { - "204": { - "description": "Delete Success" - }, - "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" - }, - "410": { - "$ref": "#/components/responses/gone" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/projects/{project_id}/collaborators": { "get": { "summary": "List project collaborators", @@ -70215,142 +70678,16 @@ "subcategory": "repos" } }, - "delete": { - "summary": "Disable private vulnerability reporting for a repository", - "description": "Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".", - "tags": [ - "repos" - ], - "operationId": "repos/disable-private-vulnerability-reporting", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository" - }, - "parameters": [ - { - "$ref": "#/components/parameters/owner" - }, - { - "$ref": "#/components/parameters/repo" - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/no_content" - }, - "422": { - "$ref": "#/components/responses/bad_request" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "repos", - "subcategory": "repos" - } - } - }, - "/repos/{owner}/{repo}/projects": { - "get": { - "summary": "List repository 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-repository-projects" - }, - "parameters": [ - { - "$ref": "#/components/parameters/owner" - }, - { - "$ref": "#/components/parameters/repo" - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/project" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-items-2" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "410": { - "$ref": "#/components/responses/gone" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "post": { - "summary": "Create a repository 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.", + "delete": { + "summary": "Disable private vulnerability reporting for a repository", + "description": "Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".", "tags": [ - "projects-classic" + "repos" ], - "operationId": "projects-classic/create-for-repo", + "operationId": "repos/disable-private-vulnerability-reporting", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-a-repository-project" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository" }, "parameters": [ { @@ -70360,78 +70697,20 @@ "$ref": "#/components/parameters/repo" } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the project." - }, - "body": { - "type": "string", - "description": "The description of the project." - } - }, - "required": [ - "name" - ] - }, - "examples": { - "default": { - "value": { - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site." - } - } - } - } - } - }, "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-3" - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "410": { - "$ref": "#/components/responses/gone" + "204": { + "$ref": "#/components/responses/no_content" }, "422": { - "$ref": "#/components/responses/validation_failed_simple" + "$ref": "#/components/responses/bad_request" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true + "category": "repos", + "subcategory": "repos" + } } }, "/repos/{owner}/{repo}/properties/values": { @@ -75458,8 +75737,12 @@ "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" } }, - "required": [ - "state" + "anyOf": [ + { + "required": [ + "state" + ] + } ] }, "examples": { @@ -87297,185 +87580,17 @@ } } }, - "/user/packages/{package_type}/{package_name}/versions": { - "get": { - "summary": "List package versions for a package owned by the authenticated user", - "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "tags": [ - "packages" - ], - "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user", - "externalDocs": { - "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": [ - { - "$ref": "#/components/parameters/package-type" - }, - { - "$ref": "#/components/parameters/package-name" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "name": "state", - "in": "query", - "required": false, - "description": "The state of the package, either active or deleted.", - "schema": { - "type": "string", - "enum": [ - "active", - "deleted" - ], - "default": "active" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/package-version" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/package-versions-for-authenticated-user" - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "packages", - "subcategory": "packages" - } - } - }, - "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { - "get": { - "summary": "Get a package version for the authenticated user", - "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "tags": [ - "packages" - ], - "operationId": "packages/get-package-version-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-the-authenticated-user" - }, - "parameters": [ - { - "$ref": "#/components/parameters/package-type" - }, - { - "$ref": "#/components/parameters/package-name" - }, - { - "$ref": "#/components/parameters/package-version-id" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/package-version" - }, - "examples": { - "default": { - "$ref": "#/components/examples/package-version-authenticated-user" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "packages", - "subcategory": "packages" - } - }, - "delete": { - "summary": "Delete a package version for the authenticated user", - "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "tags": [ - "packages" - ], - "operationId": "packages/delete-package-version-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-version-for-the-authenticated-user" - }, - "parameters": [ - { - "$ref": "#/components/parameters/package-type" - }, - { - "$ref": "#/components/parameters/package-name" - }, - { - "$ref": "#/components/parameters/package-version-id" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "packages", - "subcategory": "packages" - } - } - }, - "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { - "post": { - "summary": "Restore a package version for the authenticated user", - "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "/user/packages/{package_type}/{package_name}/versions": { + "get": { + "summary": "List package versions for a package owned by the authenticated user", + "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], - "operationId": "packages/restore-package-version-for-authenticated-user", + "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-version-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user" }, "parameters": [ { @@ -87485,12 +87600,44 @@ "$ref": "#/components/parameters/package-name" }, { - "$ref": "#/components/parameters/package-version-id" + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "name": "state", + "in": "query", + "required": false, + "description": "The state of the package, either active or deleted.", + "schema": { + "type": "string", + "enum": [ + "active", + "deleted" + ], + "default": "active" + } } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/package-version" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/package-versions-for-authenticated-user" + } + } + } + } }, "404": { "$ref": "#/components/responses/not_found" @@ -87510,98 +87657,140 @@ } } }, - "/user/projects": { - "post": { - "summary": "Create a user 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.", + "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { + "get": { + "summary": "Get a package version for the authenticated user", + "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ - "projects-classic" + "packages" ], - "operationId": "projects-classic/create-for-authenticated-user", + "operationId": "packages/get-package-version-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-a-user-project" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-the-authenticated-user" }, - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Create a new project", - "value": { - "name": "My Projects", - "body": "A board to manage my personal projects." - } - } - } - } + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/package-version-id" } - }, + ], "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/project" + "$ref": "#/components/schemas/package-version" }, "examples": { "default": { - "$ref": "#/components/examples/project" + "$ref": "#/components/examples/package-version-authenticated-user" } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + }, + "delete": { + "summary": "Delete a package version for the authenticated user", + "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/delete-package-version-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-version-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" }, - "304": { - "$ref": "#/components/responses/not_modified" + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/package-version-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" }, "403": { "$ref": "#/components/responses/forbidden" }, "401": { "$ref": "#/components/responses/requires_authentication" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + "post": { + "summary": "Restore a package version for the authenticated user", + "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/restore-package-version-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-version-for-the-authenticated-user" }, - "deprecated": true + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/package-version-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } } }, "/user/public_emails": { @@ -90833,83 +91022,6 @@ } } }, - "/users/{username}/projects": { - "get": { - "summary": "List user 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": [ - "projects-classic" - ], - "operationId": "projects-classic/list-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-user-projects" - }, - "parameters": [ - { - "$ref": "#/components/parameters/username" - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/project" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-items-3" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "projects-classic", - "subcategory": "projects", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/users/{username}/projectsV2": { "get": { "summary": "List projects for user", @@ -92116,7 +92228,7 @@ }, "/users/{username}/settings/billing/usage/summary": { "get": { - "summary": "Get billing usage summary report for a user", + "summary": "Get billing usage summary for a user", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" @@ -92124,7 +92236,7 @@ "operationId": "billing/get-github-billing-usage-summary-report-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-report-for-a-user" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-for-a-user" }, "parameters": [ { @@ -130735,6 +130847,415 @@ "repositories" ] }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the budget", + "examples": [ + "2066deda-923f-43f9-88d2-62395a28c0cdd" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "SkuPricing", + "ProductPricing" + ], + "examples": [ + "SkuPricing" + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount limit in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "The type of limit enforcement for the budget", + "examples": [ + true + ] + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "examples": [ + "octocat/hello-world" + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to." + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + }, + "required": [ + "will_alert", + "alert_recipients" + ] + } + }, + "required": [ + "id", + "budget_type", + "budget_product_sku", + "budget_scope", + "budget_amount", + "prevent_further_usage", + "budget_alerting" + ] + }, + "get_all_budgets": { + "type": "object", + "properties": { + "budgets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/budget" + }, + "description": "Array of budget objects for the enterprise" + } + }, + "required": [ + "budgets" + ] + }, + "create-budget": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the create operation" + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ], + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "examples": [ + "example-repository-name" + ] + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in dollars", + "minimum": 0.0, + "examples": [ + 100.0 + ] + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "examples": [ + true + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "examples": [ + "actions_linux" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ], + "examples": [ + "ProductPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + } + } + } + } + }, + "required": [ + "message", + "budget" + ] + }, + "get-budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ], + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "examples": [ + "octocat/hello-world" + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "examples": [ + true + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "examples": [ + "actions_linux" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ], + "examples": [ + "ProductPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + } + } + }, + "required": [ + "id", + "budget_amount", + "prevent_further_usage", + "budget_product_sku", + "budget_type", + "budget_alerting", + "budget_scope", + "budget_entity_name" + ] + }, + "update-budget": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the update operation" + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ], + "examples": [ + "enterprise" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "examples": [ + "example-repository-name" + ] + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in dollars", + "minimum": 0.0, + "examples": [ + 100.0 + ] + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "examples": [ + true + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "examples": [ + "actions_linux" + ] + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "enum": [ + "ProductPricing", + "SkuPricing" + ], + "examples": [ + "ProductPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "examples": [ + true + ] + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "examples": [ + "mona", + "lisa" + ] + } + } + } + } + } + }, + "required": [ + "budget", + "message" + ] + }, + "delete-budget": { + "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" + ] + }, "get-all-cost-centers": { "type": "object", "properties": { @@ -139133,136 +139654,6 @@ "updated_at" ] }, - "project": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, "projects-v2-status-update": { "title": "Projects v2 Status Update", "description": "An status update belonging to a project", @@ -314056,6 +314447,94 @@ ] } }, + "get_all_budgets": { + "value": { + "budgets": [ + { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "actions" + ], + "budget_scope": "enterprise", + "budget_amount": 1000.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "enterprise-admin", + "billing-manager" + ] + } + }, + { + "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", + "budget_type": "SkuPricing", + "budget_product_skus": [ + "actions_linux" + ], + "budget_scope": "organization", + "budget_amount": 500.0, + "prevent_further_usage": false, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "org-owner" + ] + } + }, + { + "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "packages" + ], + "budget_scope": "cost_center", + "budget_amount": 250.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + ] + } + }, + "create-budget": { + "value": { + "message": "Budget successfully created." + } + }, + "get-budget": { + "value": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } + }, + "update-budget": { + "value": { + "message": "Budget successfully updated.", + "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" + } + }, + "delete-budget": { + "value": { + "message": "Budget successfully deleted.", + "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" + } + }, "get-all-cost-centers": { "value": { "costCenters": [ @@ -319761,82 +320240,6 @@ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" } }, - "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": true - } - ] - }, - "project-2": { - "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" - } - }, "projects-v2": { "value": { "id": 2, @@ -322896,42 +323299,6 @@ } ] }, - "project-3": { - "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - }, "project-collaborator-permission": { "value": { "permission": "admin", @@ -333242,44 +333609,6 @@ } } }, - "project-items-2": { - "value": [ - { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - ] - }, "pull-request": { "value": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -340549,42 +340878,6 @@ } } }, - "project": { - "value": { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - }, "repository-items-default-response": { "summary": "Default response", "value": [ @@ -341266,44 +341559,6 @@ } } }, - "project-items-3": { - "value": [ - { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "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-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - } - ] - }, "user-received-events-items": { "value": [ { @@ -343736,6 +343991,15 @@ ] } }, + "budget": { + "name": "budget_id", + "description": "The ID corresponding to the budget.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "cost-center-state": { "name": "state", "in": "query", @@ -345651,6 +345915,51 @@ } } }, + "get_all_budgets": { + "description": "Response when getting all budgets", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get_all_budgets" + }, + "examples": { + "default": { + "$ref": "#/components/examples/get_all_budgets" + } + } + } + } + }, + "budget": { + "description": "Response when updating a budget", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get-budget" + }, + "examples": { + "default": { + "$ref": "#/components/examples/get-budget" + } + } + } + } + }, + "delete-budget": { + "description": "Response when deleting a budget", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/delete-budget" + }, + "examples": { + "default": { + "$ref": "#/components/examples/delete-budget" + } + } + } + } + }, "get_all_cost_centers": { "description": "Response when getting cost centers", "content": { @@ -345826,7 +346135,7 @@ } }, "billing_usage_summary_report_ghe": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { @@ -345916,7 +346225,7 @@ } }, "billing_usage_summary_report_org": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { @@ -345933,8 +346242,8 @@ "package_es_list_error": { "description": "The value of `per_page` multiplied by `page` cannot be greater than 10000." }, - "gone": { - "description": "Gone", + "temporary_redirect": { + "description": "Temporary Redirect", "content": { "application/json": { "schema": { @@ -345943,8 +346252,8 @@ } } }, - "temporary_redirect": { - "description": "Temporary Redirect", + "gone": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -346188,7 +346497,7 @@ } }, "billing_usage_summary_report_user": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index a1feeea93..9cde5a33d 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -8538,6 +8538,376 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: billing + "/enterprises/{enterprise}/settings/billing/budgets": + get: + summary: Get all budgets + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets all budgets for an enterprise. The authenticated user must be an enterprise admin or billing manager. + tags: + - billing + operationId: billing/get-all-budgets + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-all-budgets + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + "$ref": "#/components/responses/get_all_budgets" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + post: + summary: Create a budget + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise. + tags: + - billing + operationId: billing/create-budget + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#create-a-budget + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - budget_amount + - prevent_further_usage + - budget_alerting + - budget_scope + - budget_type + properties: + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + budget_alerting: + type: object + required: + - will_alert + - alert_recipients + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + default: '' + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered in the + budget + examples: + create-budget: + summary: Create budget example + value: + budget_amount: 200 + prevent_further_usage: true + budget_scope: enterprise + budget_entity_name: '' + budget_type: ProductPricing + budget_product_sku: actions + budget_alerting: + will_alert: false + alert_recipients: [] + responses: + '200': + description: Budget created successfully + content: + application/json: + schema: + "$ref": "#/components/schemas/create-budget" + examples: + create-budget: + "$ref": "#/components/examples/create-budget" + '400': + "$ref": "#/components/responses/bad_request" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + description: Feature not enabled + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + feature-not-enabled: + value: + message: Not Found + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#create-a-budget + '422': + "$ref": "#/components/responses/validation_failed" + '500': + description: Internal server error + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + server-error: + value: + message: Unable to create budget. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#create-a-budget + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": + get: + summary: Get a budget by ID + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager. + tags: + - billing + operationId: billing/get-budget + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-a-budget-by-id + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/budget" + responses: + '200': + "$ref": "#/components/responses/budget" + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + patch: + summary: Update a budget + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise. + tags: + - billing + operationId: billing/update-budget + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#update-a-budget + parameters: + - name: enterprise + in: path + required: true + schema: + type: string + description: The slug version of the enterprise name + - name: budget_id + in: path + required: true + schema: + type: string + description: The unique identifier of the budget + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered in the + budget + examples: + update-budget: + summary: Update budget example + value: + prevent_further_usage: false + budget_amount: 10 + budget_alerting: + will_alert: false + alert_recipients: [] + responses: + '200': + description: Budget updated successfully + content: + application/json: + schema: + "$ref": "#/components/schemas/update-budget" + examples: + update-budget: + "$ref": "#/components/examples/update-budget" + '400': + "$ref": "#/components/responses/bad_request" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + description: Budget not found or feature not enabled + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + budget-not-found: + value: + message: Budget with ID 550e8400-e29b-41d4-a716-446655440000 not + found. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + feature-not-enabled: + value: + message: Not Found + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + '422': + "$ref": "#/components/responses/validation_failed" + '500': + description: Internal server error + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + server-error: + value: + message: Unable to retrieve budget. + documentation_url: https://docs.github.com/rest/enterprise-admin/billing#update-a-budget + '503': + description: Service unavailable + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + server-error: + value: + message: Unable to update budget. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + delete: + summary: Delete a budget + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Deletes 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/enhanced-billing#delete-a-budget + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/budget" + responses: + '200': + "$ref": "#/components/responses/delete-budget" + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing "/enterprises/{enterprise}/settings/billing/cost-centers": get: summary: Get all cost centers for an enterprise @@ -9080,7 +9450,7 @@ paths: subcategory: billing "/enterprises/{enterprise}/settings/billing/usage/summary": get: - summary: Get billing usage summary report for an enterprise + summary: Get billing usage summary for an enterprise description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. @@ -9093,7 +9463,7 @@ paths: operationId: billing/get-github-billing-usage-summary-report-ghe externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-summary-report-for-an-enterprise + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-summary-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/billing-usage-report-year" @@ -12362,6 +12732,286 @@ paths: enabledForGitHubApps: true category: orgs subcategory: custom-properties-for-orgs + "/organizations/{org}/settings/billing/budgets": + get: + summary: Get all budgets for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-all-budgets-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-all-budgets-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + "$ref": "#/components/responses/get_all_budgets" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing + "/organizations/{org}/settings/billing/budgets/{budget_id}": + get: + summary: Get a budget by ID for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a budget by ID. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-a-budget-by-id-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/budget" + responses: + '200': + "$ref": "#/components/responses/budget" + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing + patch: + summary: Update a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/update-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#update-a-budget-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/budget" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered in the + budget + examples: + update-budget: + summary: Update budget example + value: + prevent_further_usage: false + budget_amount: 10 + budget_alerting: + will_alert: false + alert_recipients: [] + responses: + '200': + description: Budget updated successfully + content: + application/json: + schema: + type: object + properties: + message: + type: string + examples: + - Budget successfully updated. + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_amount: + type: number + format: float + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the + budget is exceeded + budget_alerting: + type: object + required: + - will_alert + - alert_recipients + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + default: '' + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered + in the budget + examples: + update-budget: + value: + message: Budget successfully updated. + id: 550e8400-e29b-41d4-a716-446655440000 + '400': + "$ref": "#/components/responses/bad_request" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + description: Budget not found or feature not enabled + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + budget-not-found: + value: + message: Budget with ID 550e8400-e29b-41d4-a716-446655440000 not + found. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + feature-not-enabled: + value: + message: Not Found + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + '422': + "$ref": "#/components/responses/validation_failed" + '500': + description: Internal server error + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + server-error: + value: + message: Unable to update budget. + documentation_url: https://docs.github.com/rest/billing/enhanced-billing#update-a-budget + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: billing + subcategory: enhanced-billing + delete: + summary: Delete a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/delete-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#delete-a-budget-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/budget" + responses: + '200': + "$ref": "#/components/responses/delete-budget" + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization @@ -12437,7 +13087,7 @@ paths: subcategory: enhanced-billing "/organizations/{org}/settings/billing/usage/summary": get: - summary: Get billing usage summary report for an organization + summary: Get billing usage summary for an organization description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. @@ -12450,7 +13100,7 @@ paths: operationId: billing/get-github-billing-usage-summary-report-org externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-report-for-an-organization + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/billing-usage-report-year" @@ -25084,121 +25734,6 @@ paths: enabledForGitHubApps: true category: private-registries subcategory: organization-configurations - "/orgs/{org}/projects": - get: - summary: List organization 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: - - projects-classic - operationId: projects-classic/list-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-organization-projects - parameters: - - "$ref": "#/components/parameters/org" - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-items" - headers: - Link: - "$ref": "#/components/headers/link" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create an organization 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: - - projects-classic - operationId: projects-classic/create-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-an-organization-project - parameters: - - "$ref": "#/components/parameters/org" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the project. - body: - type: string - description: The description of the project. - required: - - name - examples: - default: - value: - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-2" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '410': - "$ref": "#/components/responses/gone" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/orgs/{org}/projectsV2": get: summary: List projects for organization @@ -30541,194 +31076,6 @@ paths: deprecationDate: '2024-05-23' removalDate: '2025-04-01' deprecated: true - "/projects/{project_id}": - get: - summary: Get 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: - - projects-classic - operationId: projects-classic/get - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#get-a-project - parameters: - - "$ref": "#/components/parameters/project-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-3" - '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: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update 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. - operationId: projects-classic/update - tags: - - projects-classic - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#update-a-project - parameters: - - "$ref": "#/components/parameters/project-id" - requestBody: - required: false - content: - application/json: - schema: - properties: - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - state: - description: State of the project; either 'open' or 'closed' - type: string - examples: - - open - organization_permission: - description: The baseline permission that all organization members - have on this project - type: string - enum: - - read - - write - - admin - - none - private: - description: Whether or not this project can be seen by everyone. - type: boolean - type: object - examples: - default: - summary: Change the name, state, and permissions for a project - value: - name: Week One Sprint - state: open - organization_permission: write - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-3" - '404': - description: Not Found if the authenticated user does not have access to - the project - '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" - '410': - "$ref": "#/components/responses/gone" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete 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. - operationId: projects-classic/delete - tags: - - projects-classic - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#delete-a-project - parameters: - - "$ref": "#/components/parameters/project-id" - responses: - '204': - description: Delete Success - '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" - '410': - "$ref": "#/components/responses/gone" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/projects/{project_id}/collaborators": get: summary: List project collaborators @@ -50751,131 +51098,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repos/{owner}/{repo}/projects": - get: - summary: List repository 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: - - projects-classic - operationId: projects-classic/list-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-repository-projects - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-items-2" - headers: - Link: - "$ref": "#/components/headers/link" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '410': - "$ref": "#/components/responses/gone" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - post: - summary: Create a repository 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: - - projects-classic - operationId: projects-classic/create-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-a-repository-project - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the project. - body: - type: string - description: The description of the project. - required: - - name - examples: - default: - value: - name: Projects Documentation - body: Developer documentation project for the developer site. - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-3" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '410': - "$ref": "#/components/responses/gone" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/repos/{owner}/{repo}/properties/values": get: summary: Get all custom property values for a repository @@ -54512,8 +54734,9 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution" resolution_comment: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" - required: - - state + anyOf: + - required: + - state examples: default: value: @@ -63252,73 +63475,6 @@ paths: enabledForGitHubApps: false category: packages subcategory: packages - "/user/projects": - post: - summary: Create a user 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: - - projects-classic - operationId: projects-classic/create-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-a-user-project - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - required: - - name - type: object - examples: - default: - summary: Create a new project - value: - name: My Projects - body: A board to manage my personal projects. - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/user/public_emails": get: summary: List public email addresses for the authenticated user @@ -65587,59 +65743,6 @@ paths: enabledForGitHubApps: false category: packages subcategory: packages - "/users/{username}/projects": - get: - summary: List user 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: - - projects-classic - operationId: projects-classic/list-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-user-projects - parameters: - - "$ref": "#/components/parameters/username" - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-items-3" - headers: - Link: - "$ref": "#/components/headers/link" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: projects-classic - subcategory: projects - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/users/{username}/projectsV2": get: summary: List projects for user @@ -66429,7 +66532,7 @@ paths: subcategory: enhanced-billing "/users/{username}/settings/billing/usage/summary": get: - summary: Get billing usage summary report for a user + summary: Get billing usage summary for a user description: |- > [!NOTE] > This endpoint is in public preview and is subject to change. @@ -66442,7 +66545,7 @@ paths: operationId: billing/get-github-billing-usage-summary-report-user externalDocs: description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-report-for-a-user + url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-summary-for-a-user parameters: - "$ref": "#/components/parameters/username" - "$ref": "#/components/parameters/billing-usage-report-year" @@ -94523,6 +94626,307 @@ components: "$ref": "#/components/schemas/advanced-security-active-committers-repository" required: - repositories + budget: + type: object + properties: + id: + type: string + description: The unique identifier for the budget + examples: + - 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: + type: string + description: The type of pricing for the budget + enum: + - SkuPricing + - ProductPricing + examples: + - SkuPricing + budget_amount: + type: integer + description: The budget amount limit in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: The type of limit enforcement for the budget + examples: + - true + budget_scope: + type: string + description: The scope of the budget (enterprise, organization, repository, + cost center) + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity for the budget (enterprise does not + require a name). + examples: + - octocat/hello-world + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + examples: + - mona + - lisa + required: + - will_alert + - alert_recipients + required: + - id + - budget_type + - budget_product_sku + - budget_scope + - budget_amount + - prevent_further_usage + - budget_alerting + get_all_budgets: + type: object + properties: + budgets: + type: array + items: + "$ref": "#/components/schemas/budget" + description: Array of budget objects for the enterprise + required: + - budgets + create-budget: + type: object + properties: + message: + type: string + description: A message indicating the result of the create operation + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + enum: + - enterprise + - organization + - repository + - cost_center + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + examples: + - example-repository-name + budget_amount: + type: number + format: float + description: The budget amount in dollars + minimum: 0.0 + examples: + - 100.0 + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + examples: + - true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + examples: + - actions_linux + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + examples: + - ProductPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + examples: + - mona + - lisa + required: + - message + - budget + get-budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + enum: + - enterprise + - organization + - repository + - cost_center + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + examples: + - octocat/hello-world + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based products, + this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget is exceeded + examples: + - true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + examples: + - actions_linux + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + examples: + - ProductPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + examples: + - mona + - lisa + required: + - id + - budget_amount + - prevent_further_usage + - budget_product_sku + - budget_type + - budget_alerting + - budget_scope + - budget_entity_name + update-budget: + type: object + properties: + message: + type: string + description: A message indicating the result of the update operation + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + enum: + - enterprise + - organization + - repository + - cost_center + examples: + - enterprise + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + examples: + - example-repository-name + budget_amount: + type: number + format: float + description: The budget amount in dollars + minimum: 0.0 + examples: + - 100.0 + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + examples: + - true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + examples: + - actions_linux + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + examples: + - ProductPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + examples: + - mona + - lisa + required: + - budget + - message + delete-budget: + 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 get-all-cost-centers: type: object properties: @@ -100773,101 +101177,6 @@ components: - visibility - created_at - updated_at - project: - title: Project - description: Projects are a way to organize columns and cards of work. - type: object - properties: - owner_url: - type: string - format: uri - examples: - - https://api.github.com/repos/api-playground/projects-test - url: - type: string - format: uri - examples: - - https://api.github.com/projects/1002604 - html_url: - type: string - format: uri - examples: - - https://github.com/api-playground/projects-test/projects/12 - columns_url: - type: string - format: uri - examples: - - https://api.github.com/projects/1002604/columns - id: - type: integer - examples: - - 1002604 - node_id: - type: string - examples: - - MDc6UHJvamVjdDEwMDI2MDQ= - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - number: - type: integer - examples: - - 1 - state: - description: State of the project; either 'open' or 'closed' - type: string - examples: - - open - creator: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - created_at: - type: string - format: date-time - examples: - - '2011-04-10T20:09:31Z' - updated_at: - type: string - format: date-time - examples: - - '2014-03-03T18:58:10Z' - organization_permission: - description: The baseline permission that all organization members have - on this project. Only present if owner is an organization. - type: string - enum: - - read - - write - - admin - - none - private: - description: Whether or not this project can be seen by everyone. Only present - if owner is an organization. - type: boolean - required: - - id - - node_id - - number - - name - - body - - state - - url - - html_url - - owner_url - - creator - - columns_url - - created_at - - updated_at projects-v2-status-update: title: Projects v2 Status Update description: An status update belonging to a project @@ -230849,6 +231158,67 @@ components: - user_login: octokitten last_pushed_date: '2021-10-26' last_pushed_email: octokitten@github.com + get_all_budgets: + value: + budgets: + - id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_skus: + - actions + budget_scope: enterprise + budget_amount: 1000.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - enterprise-admin + - billing-manager + - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 + budget_type: SkuPricing + budget_product_skus: + - actions_linux + budget_scope: organization + budget_amount: 500.0 + prevent_further_usage: false + budget_alerting: + will_alert: true + alert_recipients: + - org-owner + - id: 6ba7b810-9dad-11d1-80b4-00c04fd430c8 + budget_type: ProductPricing + budget_product_skus: + - packages + budget_scope: cost_center + budget_amount: 250.0 + prevent_further_usage: true + budget_alerting: + will_alert: false + alert_recipients: [] + create-budget: + value: + message: Budget successfully created. + get-budget: + value: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa + update-budget: + value: + message: Budget successfully updated. + budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b + delete-budget: + value: + message: Budget successfully deleted. + budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b get-all-cost-centers: value: costCenters: @@ -235736,74 +236106,6 @@ components: value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - 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: true - project-2: - 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' projects-v2: value: id: 2 @@ -238451,39 +238753,6 @@ components: 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-3: - value: - owner_url: https://api.github.com/repos/api-playground/projects-test - url: https://api.github.com/projects/1002604 - html_url: https://github.com/api-playground/projects-test/projects/1 - columns_url: https://api.github.com/projects/1002604/columns - id: 1002604 - node_id: MDc6UHJvamVjdDEwMDI2MDQ= - name: Projects Documentation - body: Developer documentation project for the developer site. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' project-collaborator-permission: value: permission: admin @@ -247257,39 +247526,6 @@ components: https_error: is_https_eligible: true caa_error: - project-items-2: - value: - - owner_url: https://api.github.com/repos/api-playground/projects-test - url: https://api.github.com/projects/1002604 - html_url: https://github.com/api-playground/projects-test/projects/1 - columns_url: https://api.github.com/projects/1002604/columns - id: 1002604 - node_id: MDc6UHJvamVjdDEwMDI2MDQ= - name: Projects Documentation - body: Developer documentation project for the developer site. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' pull-request: value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 @@ -253578,39 +253814,6 @@ components: container: tags: - 1.13.6 - project: - value: - owner_url: https://api.github.com/users/octocat - url: https://api.github.com/projects/1002603 - html_url: https://github.com/users/octocat/projects/1 - columns_url: https://api.github.com/projects/1002603/columns - id: 1002603 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - name: My Projects - body: A board to manage my personal projects. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' repository-items-default-response: summary: Default response value: @@ -254192,39 +254395,6 @@ components: html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0 metadata: package_type: rubygems - project-items-3: - value: - - owner_url: https://api.github.com/users/octocat - url: https://api.github.com/projects/1002603 - html_url: https://github.com/users/octocat/projects/1 - columns_url: https://api.github.com/projects/1002603/columns - id: 1002603 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - name: My Projects - body: A board to manage my personal projects. - 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-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' user-received-events-items: value: - id: '22249084964' @@ -256393,6 +256563,13 @@ components: enum: - code_security - secret_protection + budget: + name: budget_id + description: The ID corresponding to the budget. + in: path + required: true + schema: + type: string cost-center-state: name: state in: query @@ -257974,6 +258151,33 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + get_all_budgets: + description: Response when getting all budgets + content: + application/json: + schema: + "$ref": "#/components/schemas/get_all_budgets" + examples: + default: + "$ref": "#/components/examples/get_all_budgets" + budget: + description: Response when updating a budget + content: + application/json: + schema: + "$ref": "#/components/schemas/get-budget" + examples: + default: + "$ref": "#/components/examples/get-budget" + delete-budget: + description: Response when deleting a budget + content: + application/json: + schema: + "$ref": "#/components/schemas/delete-budget" + examples: + default: + "$ref": "#/components/examples/delete-budget" get_all_cost_centers: description: Response when getting cost centers content: @@ -258081,7 +258285,7 @@ components: default: "$ref": "#/components/examples/billing-usage-report" billing_usage_summary_report_ghe: - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -258136,7 +258340,7 @@ components: default: "$ref": "#/components/examples/billing-usage-report" billing_usage_summary_report_org: - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -258147,14 +258351,14 @@ components: package_es_list_error: description: The value of `per_page` multiplied by `page` cannot be greater than 10000. - gone: - description: Gone + temporary_redirect: + description: Temporary Redirect content: application/json: schema: "$ref": "#/components/schemas/basic-error" - temporary_redirect: - description: Temporary Redirect + gone: + description: Gone content: application/json: schema: @@ -258306,7 +258510,7 @@ components: default: "$ref": "#/components/examples/billing-usage-report-user" billin{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}